#include "suricata-common.h"
#include "suricata.h"
#include "stream.h"
#include "runmodes.h"
#include "thread-callbacks.h"
#include "threadvars.h"
#include "thread-storage.h"
#include "tm-queues.h"
#include "tm-queuehandlers.h"
#include "tm-threads.h"
#include "tmqh-packetpool.h"
#include "threads.h"
#include "util-affinity.h"
#include "util-debug.h"
#include "util-privs.h"
#include "util-cpu.h"
#include "util-optimize.h"
#include "util-profiling.h"
#include "util-signal.h"
#include "queue.h"
#include "util-validate.h"

Include dependency graph for tm-threads.c:

Data Structures
struct	Thread_

Macros
#define	MIN_WAIT_TIME 100

#define	MAX_WAIT_TIME 999999

#define	STEP 32

Functions
int	TmThreadsCheckFlag (ThreadVars *tv, uint32_t flag)
	Check if a thread flag is set. More...

void	TmThreadsSetFlag (ThreadVars *tv, uint32_t flag)
	Set a thread flag. More...

void	TmThreadsUnsetFlag (ThreadVars *tv, uint32_t flag)
	Unset a thread flag. More...

TmEcode	TmThreadsProcessDecodePseudoPackets (ThreadVars tv, PacketQueueNoLock decode_pq, TmSlot *slot)

TmEcode	TmThreadsSlotVarRun (ThreadVars tv, Packet p, TmSlot *slot)
	Separate run function so we can call it recursively. More...

int	TmThreadTimeoutLoop (ThreadVars tv, TmSlot s)

bool	SCTmThreadsSlotPacketLoopFinish (ThreadVars *tv)

bool	TmThreadsWaitForUnpause (ThreadVars *tv)
	Wait for a thread to become unpaused. More...

void	TmSlotSetFuncAppend (ThreadVars tv, TmModule tm, const void *data)
	Appends a new entry to the slots. More...

TmEcode	TmThreadSetThreadPriority (ThreadVars *tv, int prio)
	Set the thread options (thread priority). More...

void	TmThreadSetPrio (ThreadVars *tv)
	Adjusting nice value for threads. More...

TmEcode	TmThreadSetCPUAffinity (ThreadVars *tv, uint16_t cpu)
	Set the thread options (cpu affinity). More...

TmEcode	TmThreadSetCPU (ThreadVars *tv, uint8_t type)

int	TmThreadGetNbThreads (uint8_t type)

TmEcode	TmThreadSetupOptions (ThreadVars *tv)
	Set the thread options (cpu affinitythread). Priority should be already set by pthread_create. More...

ThreadVars *	TmThreadCreate (const char name, const char inq_name, const char inqh_name, const char outq_name, const char outqh_name, const char slots, void (fn_p)(void *), int mucond)
	Creates and returns the TV instance for a new thread. More...

ThreadVars *	TmThreadCreatePacketHandler (const char name, const char inq_name, const char inqh_name, const char outq_name, const char outqh_name, const char slots)
	Creates and returns a TV instance for a Packet Processing Thread. This function doesn't support custom slots, and hence shouldn't be supplied "custom" as its slot type. All PPT threads are created with a mucond(see TmThreadCreate declaration) of 0. Hence the tv conditional variables are not used to kill the thread. More...

ThreadVars *	TmThreadCreateMgmtThread (const char name, void (fn_p)(void *), int mucond)
	Creates and returns the TV instance for a Management thread(MGMT). This function supports only custom slot functions and hence a function pointer should be sent as an argument. More...

ThreadVars *	TmThreadCreateMgmtThreadByName (const char name, const char module, int mucond)
	Creates and returns the TV instance for a Management thread(MGMT). This function supports only custom slot functions and hence a function pointer should be sent as an argument. More...

ThreadVars *	TmThreadCreateCmdThreadByName (const char name, const char module, int mucond)
	Creates and returns the TV instance for a Command thread (CMD). This function supports only custom slot functions and hence a function pointer should be sent as an argument. More...

void	TmThreadAppend (ThreadVars *tv, int type)
	Appends this TV to tv_root based on its type. More...

void	TmThreadDisableReceiveThreads (void)
	Disable all threads having the specified TMs. More...

void	TmThreadDisablePacketThreads (const uint16_t set, const uint16_t check, const uint8_t module_flags)
	Disable all packet threads. More...

void	TmThreadKillThreadsFamily (int family)

void	TmThreadKillThreads (void)

void	TmThreadSetGroupName (ThreadVars tv, const char name)

void	TmThreadClearThreadsFamily (int family)

TmEcode	TmThreadSpawn (ThreadVars *tv)
	Spawns a thread associated with the ThreadVars instance tv. More...

TmEcode	TmThreadLibSpawn (ThreadVars *tv)
	Spawns a "fake" lib thread associated with the ThreadVars instance tv. More...

void	TmThreadInitMC (ThreadVars *tv)
	Initializes the mutex and condition variables for this TV. More...

void	TmThreadWaitForFlag (ThreadVars *tv, uint32_t flags)
	Waits till the specified flag(s) is(are) set. We don't bother if the kill flag has been set or not on the thread. More...

void	TmThreadContinue (ThreadVars *tv)
	Unpauses a thread. More...

TmEcode	TmThreadWaitOnThreadRunning (void)
	Waits for all threads to be in a running state. More...

void	TmThreadContinueThreads (void)
	Unpauses all threads present in tv_root. More...

void	TmThreadCheckThreadState (void)
	Used to check the thread for certain conditions of failure. More...

TmEcode	TmThreadWaitOnThreadInit (void)
	Used to check if all threads have finished their initialization. On finding an un-initialized thread, it waits till that thread completes its initialization, before proceeding to the next thread. More...

uint32_t	TmThreadCountThreadsByTmmFlags (uint8_t flags)
	returns a count of all the threads that match the flag More...

struct Thread_	__attribute__ ((aligned(CLS)))

	SC_ATOMIC_DECLARE (SCTime_t, pktts)

void	TmThreadsSealThreads (void)

void	TmThreadsUnsealThreads (void)

void	TmThreadsListThreads (void)

int	TmThreadsRegisterThread (ThreadVars *tv, const int type)

void	TmThreadsUnregisterThread (const int id)

void	TmThreadsSetThreadTimestamp (const int id, const SCTime_t ts)

bool	TmThreadsTimeSubsysIsReady (void)

void	TmThreadsInitThreadsTimestamp (const SCTime_t ts)

SCTime_t	TmThreadsGetThreadTime (const int idx)

void	TmThreadsGetMinimalTimestamp (struct timeval *ts)

uint16_t	TmThreadsGetWorkerThreadMax (void)

void	TmThreadsInjectFlowById (Flow *f, const int id)
	inject a flow into a threads flow queue More...

Variables
ThreadVars *	tv_root [TVT_MAX] = { NULL }

SCMutex	tv_root_lock = SCMUTEX_INITIALIZER

ThreadVars *	tv

const char *	name

int	type

int	in_use

SCTime_t	sys_sec_stamp

SCSpinlock	spin

	Threads

Detailed Description

Author: Victor Julien victo.nosp@m.r@in.nosp@m.linia.nosp@m.c.ne.nosp@m.t; Anoop Saldanha anoop.nosp@m.sald.nosp@m.anha@.nosp@m.gmai.nosp@m.l.com; Eric Leblond eric@.nosp@m.regi.nosp@m.t.org

Thread management functions.

Definition in file tm-threads.c.

Macro Definition Documentation

◆ MAX_WAIT_TIME

#define MAX_WAIT_TIME 999999

Definition at line 1594 of file tm-threads.c.

◆ MIN_WAIT_TIME

#define MIN_WAIT_TIME 100

Definition at line 1593 of file tm-threads.c.

◆ STEP

#define STEP 32

Definition at line 2210 of file tm-threads.c.

Function Documentation

◆ attribute()

struct Thread_ __attribute__ ( (aligned(CLS)) )

Definition at line 2092 of file tm-threads.c.

◆ SC_ATOMIC_DECLARE()

__attribute__::SC_ATOMIC_DECLARE	(	SCTime_t	,
		pktts
	)

current packet time of this thread (offline mode)

◆ SCTmThreadsSlotPacketLoopFinish()

bool SCTmThreadsSlotPacketLoopFinish ( ThreadVars * tv )

Definition at line 273 of file tm-threads.c.

References PacketPoolDestroy(), SC_ATOMIC_GET, TmSlot_::slot_next, StatsSyncCounters(), ThreadVars_::stream_pq, THV_CLOSED, THV_DEINIT, THV_FLOW_LOOP, THV_RUNNING_DONE, TM_ECODE_OK, ThreadVars_::tm_slots, TmThreadsSetFlag(), TmThreadTimeoutLoop(), TmThreadWaitForFlag(), and tv.

Here is the call graph for this function:

◆ TmSlotSetFuncAppend()

void TmSlotSetFuncAppend	(	ThreadVars *	tv,
		TmModule *	tm,
		const void *	data
	)

Appends a new entry to the slots.

Parameters

tv	TV the slot is attached to.
tm	TM to append.
data	Data to be passed on to the slot init function.

Return values

The	allocated TmSlot or NULL if there is an error

Definition at line 658 of file tm-threads.c.

References ThreadVars_::break_loop, TmModule_::cap_flags, ThreadVars_::cap_flags, TmModule_::flags, TmModule_::Func, TmSlot_::Management, TmModule_::Management, TmModule_::PktAcqBreakLoop, TmSlot_::PktAcqLoop, TmModule_::PktAcqLoop, SC_ATOMIC_INITPTR, SCCalloc, TmSlot_::slot_initdata, TmSlot_::slot_next, TmSlot_::SlotFunc, TmSlot_::SlotThreadDeinit, TmSlot_::SlotThreadExitPrintStats, TmSlot_::SlotThreadInit, TmModule_::ThreadDeinit, TmModule_::ThreadExitPrintStats, TmModule_::ThreadInit, TmSlot_::tm_flags, TmSlot_::tm_id, ThreadVars_::tm_slots, ThreadVars_::tmm_flags, TmModuleGetIDForTM(), tv, and unlikely.

Referenced by RunModeErfFileAutoFp(), RunModeErfFileSingle(), RunModeFilePcapAutoFp(), RunModeFilePcapSingle(), RunModeSetIPSAutoFp(), RunModeSetIPSWorker(), RunModeSetLiveCaptureAutoFp(), TmThreadCreateCmdThreadByName(), and TmThreadCreateMgmtThreadByName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadAppend()

void TmThreadAppend	(	ThreadVars *	tv,
		int	type
	)

Appends this TV to tv_root based on its type.

Parameters

type	holds the type this TV belongs to.

Definition at line 1184 of file tm-threads.c.

References ThreadVars_::next, SCMutexLock, SCMutexUnlock, tv, tv_root, tv_root_lock, and type.

Referenced by TmThreadSpawn().

Here is the caller graph for this function:

◆ TmThreadCheckThreadState()

void TmThreadCheckThreadState ( void )

Used to check the thread for certain conditions of failure.

Definition at line 2006 of file tm-threads.c.

References FatalError, ThreadVars_::name, ThreadVars_::next, SCMutexLock, SCMutexUnlock, THV_FAILED, TmThreadsCheckFlag(), tv, tv_root, tv_root_lock, and TVT_MAX.

Referenced by SuricataMainLoop().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadClearThreadsFamily()

void TmThreadClearThreadsFamily ( int family )

Definition at line 1699 of file tm-threads.c.

References ThreadVars_::next, SCMutexLock, tv, tv_root, tv_root_lock, and TVT_MAX.

◆ TmThreadContinue()

void TmThreadContinue ( ThreadVars * tv )

Unpauses a thread.

Parameters

tv	Pointer to a TV instance that has to be unpaused

Definition at line 1854 of file tm-threads.c.

References THV_PAUSE, TmThreadsUnsetFlag(), and tv.

Referenced by TmThreadContinueDetectLoaderThreads(), and TmThreadContinueThreads().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadContinueThreads()

void TmThreadContinueThreads ( void )

Unpauses all threads present in tv_root.

Definition at line 1990 of file tm-threads.c.

References ThreadVars_::next, SCMutexLock, SCMutexUnlock, TmThreadContinue(), tv, tv_root, tv_root_lock, and TVT_MAX.

Referenced by SuricataPostInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadCountThreadsByTmmFlags()

uint32_t TmThreadCountThreadsByTmmFlags ( uint8_t flags )

returns a count of all the threads that match the flag

Definition at line 2092 of file tm-threads.c.

References cnt, flags, ThreadVars_::next, SCMutexLock, SCMutexUnlock, ThreadVars_::tmm_flags, tv, tv_root, tv_root_lock, and TVT_MAX.

Referenced by PacketPoolPostRunmodes().

Here is the caller graph for this function:

◆ TmThreadCreate()

ThreadVars* TmThreadCreate	(	const char *	name,
		const char *	inq_name,
		const char *	inqh_name,
		const char *	outq_name,
		const char *	outqh_name,
		const char *	slots,
		void ()(void *)	fn_p,
		int	mucond
	)

Creates and returns the TV instance for a new thread.

Parameters

name	Name of this TV instance
inq_name	Incoming queue name
inqh_name	Incoming queue handler name as set by TmqhSetup()
outq_name	Outgoing queue name
outqh_name	Outgoing queue handler as set by TmqhSetup()
slots	String representation for the slot function to be used
fn_p	Pointer to function when "slots" is of type "custom"
mucond	Flag to indicate whether to initialize the condition and the mutex variables for this newly created TV.

Return values

the	newly created TV instance, or NULL on error

Definition at line 938 of file tm-threads.c.

References Tmqh_::InHandler, ThreadVars_::inq, ThreadVars_::inq_id, StatsPublicThreadContext_::m, ThreadVars_::name, name, ThreadVars_::outctx, Tmqh_::OutHandler, Tmqh_::OutHandlerCtxSetup, ThreadVars_::outq, ThreadVars_::outq_id, ThreadVars_::perf_public_ctx, Tmq_::reader_cnt, SC_ATOMIC_INIT, SCCalloc, SCLogDebug, SCMutexInit, strlcpy(), ThreadStorageSize(), THV_PAUSE, TmqCreateQueue(), TmqGetQueueByName(), ThreadVars_::tmqh_in, ThreadVars_::tmqh_out, TmqhGetQueueHandlerByName(), TmqhNameToID(), TmThreadsSetFlag(), tv, unlikely, and Tmq_::writer_cnt.

Referenced by TmThreadCreateCmdThreadByName(), TmThreadCreateMgmtThread(), TmThreadCreateMgmtThreadByName(), and TmThreadCreatePacketHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadCreateCmdThreadByName()

ThreadVars* TmThreadCreateCmdThreadByName	(	const char *	name,
		const char *	module,
		int	mucond
	)

Creates and returns the TV instance for a Command thread (CMD). This function supports only custom slot functions and hence a function pointer should be sent as an argument.

Parameters

name	Name of this TV instance
module	Name of TmModule with COMMAND flag set.
mucond	Flag to indicate whether to initialize the condition and the mutex variables for this newly created TV.

Return values

the	newly created TV instance, or NULL on error

Definition at line 1158 of file tm-threads.c.

References ThreadVars_::id, m, MANAGEMENT_CPU_SET, name, TmModuleGetByName(), TmSlotSetFuncAppend(), TmThreadCreate(), TmThreadSetCPU(), TmThreadsRegisterThread(), tv, TVT_CMD, and ThreadVars_::type.

Here is the call graph for this function:

◆ TmThreadCreateMgmtThread()

ThreadVars* TmThreadCreateMgmtThread	(	const char *	name,
		void *	fn_p)(void *,
		int	mucond
	)

Creates and returns the TV instance for a Management thread(MGMT). This function supports only custom slot functions and hence a function pointer should be sent as an argument.

Parameters

name	Name of this TV instance
fn_p	Pointer to function when "slots" is of type "custom"
mucond	Flag to indicate whether to initialize the condition and the mutex variables for this newly created TV.

Return values

the	newly created TV instance, or NULL on error

Definition at line 1097 of file tm-threads.c.

References ThreadVars_::id, MANAGEMENT_CPU_SET, name, TmThreadCreate(), TmThreadSetCPU(), TmThreadsRegisterThread(), tv, TVT_MGMT, and ThreadVars_::type.

Here is the call graph for this function:

◆ TmThreadCreateMgmtThreadByName()

ThreadVars* TmThreadCreateMgmtThreadByName	(	const char *	name,
		const char *	module,
		int	mucond
	)

Creates and returns the TV instance for a Management thread(MGMT). This function supports only custom slot functions and hence a function pointer should be sent as an argument.

Parameters

name	Name of this TV instance
module	Name of TmModule with MANAGEMENT flag set.
mucond	Flag to indicate whether to initialize the condition and the mutex variables for this newly created TV.

Return values

the	newly created TV instance, or NULL on error

Definition at line 1125 of file tm-threads.c.

References ThreadVars_::id, m, MANAGEMENT_CPU_SET, name, TmModuleGetByName(), TmSlotSetFuncAppend(), TmThreadCreate(), TmThreadSetCPU(), TmThreadsRegisterThread(), tv, TVT_MGMT, and ThreadVars_::type.

Referenced by BypassedFlowManagerThreadSpawn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadCreatePacketHandler()

ThreadVars* TmThreadCreatePacketHandler	(	const char *	name,
		const char *	inq_name,
		const char *	inqh_name,
		const char *	outq_name,
		const char *	outqh_name,
		const char *	slots
	)

Creates and returns a TV instance for a Packet Processing Thread. This function doesn't support custom slots, and hence shouldn't be supplied "custom" as its slot type. All PPT threads are created with a mucond(see TmThreadCreate declaration) of 0. Hence the tv conditional variables are not used to kill the thread.

Parameters

name	Name of this TV instance
inq_name	Incoming queue name
inqh_name	Incoming queue handler name as set by TmqhSetup()
outq_name	Outgoing queue name
outqh_name	Outgoing queue handler as set by TmqhSetup()
slots	String representation for the slot function to be used

Return values

the	newly created TV instance, or NULL on error

Definition at line 1068 of file tm-threads.c.

References ThreadVars_::id, name, TmThreadCreate(), TmThreadsRegisterThread(), tv, TVT_PPT, and ThreadVars_::type.

Referenced by RunModeErfFileAutoFp(), RunModeErfFileSingle(), RunModeFilePcapAutoFp(), RunModeFilePcapSingle(), RunModeSetIPSAutoFp(), RunModeSetIPSWorker(), and RunModeSetLiveCaptureAutoFp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadDisablePacketThreads()

void TmThreadDisablePacketThreads	(	const uint16_t	set,
		const uint16_t	check,
		const uint8_t	module_flags
	)

Disable all packet threads.

Parameters

set	flag to set
check	flag to check
module_flags	bitflags of TmModule's to apply the `set` flag to.

Support 2 stages in shutting down the packet threads:

set THV_REQ_FLOW_LOOP and wait for THV_FLOW_LOOP
set THV_KILL and wait for THV_RUNNING_DONE

During step 1 the main loop is exited, and the flow loop logic is entered. During step 2, the flow loop logic is done and the thread closes.

module_flags limits which threads are disabled

Definition at line 1536 of file tm-threads.c.

Referenced by PostRunDeinit().

Here is the caller graph for this function:

◆ TmThreadDisableReceiveThreads()

void TmThreadDisableReceiveThreads ( void )

Disable all threads having the specified TMs.

Breaks out of the packet acquisition loop, and bumps into the 'flow loop', where it will process packets from the flow engine's shutdown handling.

Definition at line 1385 of file tm-threads.c.

References FatalError, TmModule_::flags, ThreadVars_::name, SCMutexLock, TmSlot_::slot_next, TM_FLAG_RECEIVE_TM, TmSlot_::tm_id, ThreadVars_::tm_slots, TmModuleGetById(), tv, tv_root, tv_root_lock, and TVT_PPT.

Referenced by PostRunDeinit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadGetNbThreads()

int TmThreadGetNbThreads ( uint8_t type )

Definition at line 847 of file tm-threads.c.

References MAX_CPU_SET, ThreadsAffinityType_::nb_threads, SCLogError, thread_affinity, and type.

Referenced by RunModeErfFileAutoFp(), RunModeFilePcapAutoFp(), and TmThreadsGetWorkerThreadMax().

Here is the caller graph for this function:

◆ TmThreadInitMC()

void TmThreadInitMC ( ThreadVars * tv )

Initializes the mutex and condition variables for this TV.

It can be used by a thread to control a wait loop that can also be influenced by other threads.

Parameters

tv	Pointer to a TV instance

Definition at line 1801 of file tm-threads.c.

References ThreadVars_::ctrl_cond, ThreadVars_::ctrl_mutex, FatalError, SCCtrlCondInit, SCCtrlMutexInit, SCMalloc, and tv.

◆ TmThreadKillThreads()

void TmThreadKillThreads ( void )

Definition at line 1623 of file tm-threads.c.

References TmThreadKillThreadsFamily(), and TVT_MAX.

Referenced by SuricataShutdown().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadKillThreadsFamily()

void TmThreadKillThreadsFamily ( int family )

Definition at line 1594 of file tm-threads.c.

References BUG_ON, MIN_WAIT_TIME, SCMutexLock, tv, tv_root, tv_root_lock, and TVT_MAX.

Referenced by TmThreadKillThreads().

Here is the caller graph for this function:

◆ TmThreadLibSpawn()

TmEcode TmThreadLibSpawn ( ThreadVars * tv )

Spawns a "fake" lib thread associated with the ThreadVars instance tv.

Return values

TM_ECODE_OK on success and TM_ECODE_FAILED on failure

Definition at line 1777 of file tm-threads.c.

References THV_INIT_DONE, THV_RUNNING_DONE, TM_ECODE_FAILED, TM_ECODE_OK, ThreadVars_::tm_func, TmThreadWaitForFlag(), and tv.

Referenced by SCRunModeLibSpawnWorker().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadsCheckFlag()

int TmThreadsCheckFlag	(	ThreadVars *	tv,
		uint32_t	flag
	)

Check if a thread flag is set.

Return values

1	flag is set.
0	flag is not set.

Definition at line 93 of file tm-threads.c.

References SC_ATOMIC_GET, and tv.

Referenced by FlowDisableFlowManagerThread(), TmThreadCheckThreadState(), TmThreadsWaitForUnpause(), TmThreadWaitForFlag(), and TmThreadWaitOnThreadInit().

Here is the caller graph for this function:

◆ TmThreadSetCPU()

TmEcode TmThreadSetCPU	(	ThreadVars *	tv,
		uint8_t	type
	)

Definition at line 831 of file tm-threads.c.

References ThreadVars_::cpu_affinity, MAX_CPU_SET, SCLogError, THREAD_SET_AFFTYPE, ThreadVars_::thread_setup_flags, threading_set_cpu_affinity, TM_ECODE_FAILED, TM_ECODE_OK, tv, and type.

Referenced by RunModeFilePcapAutoFp(), RunModeFilePcapSingle(), RunModeSetIPSAutoFp(), RunModeSetIPSWorker(), RunModeSetLiveCaptureAutoFp(), TmThreadCreateCmdThreadByName(), TmThreadCreateMgmtThread(), and TmThreadCreateMgmtThreadByName().

Here is the caller graph for this function:

◆ TmThreadSetCPUAffinity()

TmEcode TmThreadSetCPUAffinity	(	ThreadVars *	tv,
		uint16_t	cpu
	)

Set the thread options (cpu affinity).

Parameters

tv	pointer to the ThreadVars to setup the affinity.
cpu	cpu on which affinity is set.

Return values

TM_ECODE_OK

Definition at line 822 of file tm-threads.c.

References ThreadVars_::cpu_affinity, THREAD_SET_AFFINITY, ThreadVars_::thread_setup_flags, TM_ECODE_OK, and tv.

Referenced by RunModeErfFileAutoFp().

Here is the caller graph for this function:

◆ TmThreadSetGroupName()

void TmThreadSetGroupName	(	ThreadVars *	tv,
		const char *	name
	)

Definition at line 1681 of file tm-threads.c.

References name, SCLogError, SCStrdup, ThreadVars_::thread_group_name, tv, and unlikely.

Referenced by RunModeErfFileAutoFp(), RunModeFilePcapAutoFp(), RunModeSetIPSAutoFp(), and RunModeSetLiveCaptureAutoFp().

Here is the caller graph for this function:

◆ TmThreadSetPrio()

void TmThreadSetPrio ( ThreadVars * tv )

Adjusting nice value for threads.

Definition at line 785 of file tm-threads.c.

References ThreadVars_::name, SCEnter, SCLogDebug, SCLogError, SCReturn, ThreadVars_::thread_priority, and tv.

◆ TmThreadSetThreadPriority()

TmEcode TmThreadSetThreadPriority	(	ThreadVars *	tv,
		int	prio
	)

Set the thread options (thread priority).

Parameters

tv	Pointer to the ThreadVars to setup the thread priority.

Return values

TM_ECODE_OK.

Definition at line 774 of file tm-threads.c.

References ThreadVars_::thread_priority, THREAD_SET_PRIORITY, ThreadVars_::thread_setup_flags, TM_ECODE_OK, and tv.

Referenced by RunModeErfFileAutoFp().

Here is the caller graph for this function:

◆ TmThreadSetupOptions()

TmEcode TmThreadSetupOptions ( ThreadVars * tv )

Set the thread options (cpu affinitythread). Priority should be already set by pthread_create.

Parameters

tv	pointer to the ThreadVars of the calling thread.

Definition at line 863 of file tm-threads.c.

References ThreadVars_::cpu_affinity, ThreadVars_::name, SCGetThreadIdLong, SCLogPerf, THREAD_SET_AFFINITY, ThreadVars_::thread_setup_flags, and tv.

◆ TmThreadsGetMinimalTimestamp()

void TmThreadsGetMinimalTimestamp ( struct timeval * ts )

Definition at line 2369 of file tm-threads.c.

References SCTIME_INITIALIZER.

◆ TmThreadsGetThreadTime()

SCTime_t TmThreadsGetThreadTime ( const int idx )

Definition at line 2361 of file tm-threads.c.

References DEBUG_VALIDATE_BUG_ON.

◆ TmThreadsGetWorkerThreadMax()

uint16_t TmThreadsGetWorkerThreadMax ( void )

Definition at line 2410 of file tm-threads.c.

References SCLogWarning, threading_detect_ratio, TmThreadGetNbThreads(), UtilCpuGetNumProcessorsOnline(), and WORKER_CPU_SET.

Referenced by RunModeSetIPSAutoFp(), and RunModeSetLiveCaptureAutoFp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadsInitThreadsTimestamp()

void TmThreadsInitThreadsTimestamp ( const SCTime_t ts )

Definition at line 2342 of file tm-threads.c.

Referenced by PcapFileDispatch().

Here is the caller graph for this function:

◆ TmThreadsInjectFlowById()

void TmThreadsInjectFlowById	(	Flow *	f,
		const int	id
	)

inject a flow into a threads flow queue

Definition at line 2428 of file tm-threads.c.

Referenced by FlowSendToLocalThread().

Here is the caller graph for this function:

◆ TmThreadsListThreads()

void TmThreadsListThreads ( void )

Definition at line 2189 of file tm-threads.c.

References SCMutexLock.

◆ TmThreadSpawn()

TmEcode TmThreadSpawn ( ThreadVars * tv )

Spawns a thread associated with the ThreadVars instance tv.

Return values

TM_ECODE_OK on success and TM_ECODE_FAILED on failure

Definition at line 1724 of file tm-threads.c.

References FatalError, ThreadVars_::name, SCLogDebug, ThreadVars_::t, threading_set_stack_size, THV_INIT_DONE, THV_RUNNING_DONE, TM_ECODE_OK, ThreadVars_::tm_func, TmThreadAppend(), TmThreadWaitForFlag(), tv, and ThreadVars_::type.

Referenced by BypassedFlowManagerThreadSpawn(), RunModeErfFileAutoFp(), RunModeErfFileSingle(), RunModeFilePcapAutoFp(), RunModeFilePcapSingle(), RunModeSetIPSAutoFp(), RunModeSetIPSWorker(), and RunModeSetLiveCaptureAutoFp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadsProcessDecodePseudoPackets()

TmEcode TmThreadsProcessDecodePseudoPackets	(	ThreadVars *	tv,
		PacketQueueNoLock *	decode_pq,
		TmSlot *	slot
	)

Definition at line 114 of file tm-threads.c.

References DEBUG_VALIDATE_BUG_ON, Packet_::flow, PacketDequeueNoLock(), PacketQueueNoLock_::top, and unlikely.

Here is the call graph for this function:

◆ TmThreadsRegisterThread()

int TmThreadsRegisterThread	(	ThreadVars *	tv,
		const int	type
	)

Return values

id	thread id, or 0 if not found

Definition at line 2213 of file tm-threads.c.

References SCMutexLock.

Referenced by TmThreadCreateCmdThreadByName(), TmThreadCreateMgmtThread(), TmThreadCreateMgmtThreadByName(), and TmThreadCreatePacketHandler().

Here is the caller graph for this function:

◆ TmThreadsSealThreads()

void TmThreadsSealThreads ( void )

Definition at line 2173 of file tm-threads.c.

References SCMutexLock.

◆ TmThreadsSetFlag()

void TmThreadsSetFlag	(	ThreadVars *	tv,
		uint32_t	flag
	)

Set a thread flag.

Definition at line 101 of file tm-threads.c.

References SC_ATOMIC_OR, and tv.

Referenced by FlowDisableFlowManagerThread(), ReceiveErfDagLoop(), ReceiveErfFileLoop(), SCRunModeLibSpawnWorker(), SCTmThreadsSlotPacketLoopFinish(), TmThreadCreate(), and TmThreadsWaitForUnpause().

Here is the caller graph for this function:

◆ TmThreadsSetThreadTimestamp()

void TmThreadsSetThreadTimestamp	(	const int	id,
		const SCTime_t	ts
	)

Definition at line 2297 of file tm-threads.c.

◆ TmThreadsSlotVarRun()

TmEcode TmThreadsSlotVarRun	(	ThreadVars *	tv,
		Packet *	p,
		TmSlot *	slot
	)

Separate run function so we can call it recursively.

Definition at line 133 of file tm-threads.c.

References DEBUG_VALIDATE_BUG_ON, Packet_::flow, PACKET_PROFILING_TMM_END, PACKET_PROFILING_TMM_START, SC_ATOMIC_GET, TmSlot_::slot_next, TM_ECODE_FAILED, tv, and unlikely.

◆ TmThreadsTimeSubsysIsReady()

bool TmThreadsTimeSubsysIsReady ( void )

Definition at line 2318 of file tm-threads.c.

References SCTIME_INITIALIZER.

◆ TmThreadsUnregisterThread()

void TmThreadsUnregisterThread ( const int id )

Definition at line 2263 of file tm-threads.c.

References SCMutexLock.

◆ TmThreadsUnsealThreads()

void TmThreadsUnsealThreads ( void )

Definition at line 2181 of file tm-threads.c.

References SCMutexLock.

Referenced by PostRunDeinit().

Here is the caller graph for this function:

◆ TmThreadsUnsetFlag()

void TmThreadsUnsetFlag	(	ThreadVars *	tv,
		uint32_t	flag
	)

Unset a thread flag.

Definition at line 109 of file tm-threads.c.

References SC_ATOMIC_AND, and tv.

Referenced by TmThreadContinue(), and TmThreadsWaitForUnpause().

Here is the caller graph for this function:

◆ TmThreadsWaitForUnpause()

bool TmThreadsWaitForUnpause ( ThreadVars * tv )

Wait for a thread to become unpaused.

Also returns if the kill flag is set.

Definition at line 363 of file tm-threads.c.

References SleepUsec, THV_KILL, THV_PAUSE, THV_PAUSED, TmThreadsCheckFlag(), TmThreadsSetFlag(), TmThreadsUnsetFlag(), and tv.

Here is the call graph for this function:

◆ TmThreadTimeoutLoop()

int TmThreadTimeoutLoop	(	ThreadVars *	tv,
		TmSlot *	s
	)

Definition at line 166 of file tm-threads.c.

References DEBUG_VALIDATE_BUG_ON, Packet_::flow, len, PacketQueue_::len, likely, PacketQueue_::mutex_q, PacketDequeue(), SCLogDebug, SCMutexLock, SCMutexUnlock, ThreadVars_::stream_pq, TM_ECODE_OK, ThreadVars_::tm_flowworker, and tv.

Referenced by SCTmThreadsSlotPacketLoopFinish().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadWaitForFlag()

void TmThreadWaitForFlag	(	ThreadVars *	tv,
		uint32_t	flags
	)

Waits till the specified flag(s) is(are) set. We don't bother if the kill flag has been set or not on the thread.

Parameters

tv	Pointer to the TV instance.

Definition at line 1842 of file tm-threads.c.

References flags, SleepUsec, TmThreadsCheckFlag(), and tv.

Referenced by SCTmThreadsSlotPacketLoopFinish(), TmThreadLibSpawn(), and TmThreadSpawn().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadWaitOnThreadInit()

TmEcode TmThreadWaitOnThreadInit ( void )

Used to check if all threads have finished their initialization. On finding an un-initialized thread, it waits till that thread completes its initialization, before proceeding to the next thread.

Return values

TM_ECODE_OK	all initialized properly
TM_ECODE_FAILED	failure

Definition at line 2029 of file tm-threads.c.

References ThreadVars_::name, ThreadVars_::next, SC_ATOMIC_GET, SCLogError, SCMutexLock, SCMutexUnlock, SleepUsec, THV_CLOSED, THV_DEAD, THV_FAILED, THV_INIT_DONE, TM_ECODE_FAILED, TM_ECODE_OK, TmThreadsCheckFlag(), tv, tv_root, tv_root_lock, and TVT_MAX.

Referenced by SuricataPostInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TmThreadWaitOnThreadRunning()

TmEcode TmThreadWaitOnThreadRunning ( void )

Waits for all threads to be in a running state.

Return values

TM_ECODE_OK if all are running or error if a thread failed

Definition at line 1921 of file tm-threads.c.

References TVT_MAX.

Referenced by SuricataPostInit().

Here is the caller graph for this function:

Variable Documentation

◆ in_use

int in_use

bool to indicate this is in use

Definition at line 2165 of file tm-threads.c.

◆ name

const char* name

Definition at line 2163 of file tm-threads.c.

Referenced by BuildCpusetWithCallback(), CaptureStatsSetup(), ConfigSetDataDirectory(), ConfigSetLogDirectory(), DatajsonGet(), DatasetFind(), DatasetGet(), DatasetGetOrCreate(), DetectEngineContentModifierBufferSetup(), DetectEngineFrameInspectEngineRegister(), DetectEngineFrameMpmRegister(), DetectFrameMpmRegister(), DetectPktInspectEngineRegister(), DetectRegisterAppLayerHookLists(), DetectUnregisterThreadCtxFuncs(), DumpPatterns(), EngineAnalysisFP(), EngineAnalysisRules2(), EveAddFlowTcpFlags(), EveAddFlowTcpStreamFlags(), FlowEndCountersRegister(), FlowStorageRegister(), GetAffinityTypeForNameAndIface(), GetOrAllocAffinityTypeForIfaceOfName(), HostStorageRegister(), InjectPacketsForFlush(), IPPairStorageRegister(), ListAppLayerHooks(), LiveDevStorageRegister(), LiveGetDevice(), MpmFactoryRegisterMpmCtxProfile(), OutputRegisterPacketModule(), OutputRegisterPacketSubModule(), PatternMatchDefaultMatcher(), PrefilterAppendEngine(), PrefilterAppendFrameEngine(), PrefilterAppendPayloadEngine(), PrefilterAppendPostRuleEngine(), PrefilterAppendTxEngine(), SCClassConfGetClasstype(), SCConfGet(), SCConfGetBool(), SCConfGetDouble(), SCConfGetFloat(), SCConfGetInt(), SCConfNodeDump(), SCConfNodeGetNodeOrCreate(), SCConfNodeLookupChild(), SCConfNodeLookupChildValue(), SCConfRemove(), SCConfSetFromString(), SCDetectHelperBufferRegister(), SCEveFindFileType(), SCParseCommandLine(), SigTableHasKeyword(), SigTableList(), SigTableRegisterTests(), SinglePatternMatchDefaultMatcher(), TestHelperBufferToFile(), ThreadStorageRegister(), TmModuleBypassedFlowManagerRegister(), TmModuleGetByName(), TmqGetQueueByName(), TmqhGetQueueHandlerByName(), TmqhNameToID(), TmThreadCreate(), TmThreadCreateCmdThreadByName(), TmThreadCreateMgmtThread(), TmThreadCreateMgmtThreadByName(), TmThreadCreatePacketHandler(), TmThreadSetGroupName(), VarNameStoreLookupById(), VarNameStoreLookupByName(), and VarNameStoreSetupLookup().

◆ spin

SCSpinlock spin

Definition at line 2171 of file tm-threads.c.

◆ sys_sec_stamp

SCTime_t sys_sec_stamp

timestamp in real system time when the pktts was last updated.

Definition at line 2169 of file tm-threads.c.

◆ Threads

Threads

Definition at line 2167 of file tm-threads.c.

◆ tv

ThreadVars* tv

threadvars structure

Definition at line 2162 of file tm-threads.c.

Referenced by SCTmThreadsSlotPacketLoopFinish(), TmSlotSetFuncAppend(), TmThreadAppend(), TmThreadCheckThreadState(), TmThreadClearThreadsFamily(), TmThreadContinue(), TmThreadContinueThreads(), TmThreadCountThreadsByTmmFlags(), TmThreadCreate(), TmThreadCreateCmdThreadByName(), TmThreadCreateMgmtThread(), TmThreadCreateMgmtThreadByName(), TmThreadCreatePacketHandler(), TmThreadDisableReceiveThreads(), TmThreadInitMC(), TmThreadKillThreadsFamily(), TmThreadLibSpawn(), TmThreadsCheckFlag(), TmThreadSetCPU(), TmThreadSetCPUAffinity(), TmThreadSetGroupName(), TmThreadSetPrio(), TmThreadSetThreadPriority(), TmThreadSetupOptions(), TmThreadSpawn(), TmThreadsSetFlag(), TmThreadsSlotVarRun(), TmThreadsUnsetFlag(), TmThreadsWaitForUnpause(), TmThreadTimeoutLoop(), TmThreadWaitForFlag(), and TmThreadWaitOnThreadInit().

◆ tv_root

ThreadVars* tv_root[TVT_MAX] = { NULL }

Definition at line 82 of file tm-threads.c.

Referenced by FlowDisableFlowManagerThread(), TmThreadAppend(), TmThreadCheckThreadState(), TmThreadClearThreadsFamily(), TmThreadContinueDetectLoaderThreads(), TmThreadContinueThreads(), TmThreadCountThreadsByTmmFlags(), TmThreadDisableReceiveThreads(), TmThreadKillThreadsFamily(), and TmThreadWaitOnThreadInit().

◆ tv_root_lock

SCMutex tv_root_lock = SCMUTEX_INITIALIZER

Definition at line 85 of file tm-threads.c.

Referenced by FlowDisableFlowManagerThread(), TmThreadAppend(), TmThreadCheckThreadState(), TmThreadClearThreadsFamily(), TmThreadContinueDetectLoaderThreads(), TmThreadContinueThreads(), TmThreadCountThreadsByTmmFlags(), TmThreadDisableReceiveThreads(), TmThreadKillThreadsFamily(), and TmThreadWaitOnThreadInit().

◆ type

int type

Definition at line 2164 of file tm-threads.c.

Referenced by TmThreadAppend(), TmThreadGetNbThreads(), and TmThreadSetCPU().

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ MAX_WAIT_TIME

◆ MIN_WAIT_TIME

◆ STEP

Function Documentation

◆ __attribute__()

◆ SC_ATOMIC_DECLARE()

◆ SCTmThreadsSlotPacketLoopFinish()

◆ TmSlotSetFuncAppend()

◆ TmThreadAppend()

◆ TmThreadCheckThreadState()

◆ TmThreadClearThreadsFamily()

◆ TmThreadContinue()

◆ TmThreadContinueThreads()

◆ TmThreadCountThreadsByTmmFlags()

◆ TmThreadCreate()

◆ TmThreadCreateCmdThreadByName()

◆ TmThreadCreateMgmtThread()

◆ TmThreadCreateMgmtThreadByName()

◆ TmThreadCreatePacketHandler()

◆ TmThreadDisablePacketThreads()

◆ TmThreadDisableReceiveThreads()

◆ TmThreadGetNbThreads()

◆ TmThreadInitMC()

◆ TmThreadKillThreads()

◆ TmThreadKillThreadsFamily()

◆ TmThreadLibSpawn()

◆ TmThreadsCheckFlag()

◆ TmThreadSetCPU()

◆ TmThreadSetCPUAffinity()

◆ TmThreadSetGroupName()

◆ TmThreadSetPrio()

◆ TmThreadSetThreadPriority()

◆ TmThreadSetupOptions()

◆ TmThreadsGetMinimalTimestamp()

◆ TmThreadsGetThreadTime()

◆ TmThreadsGetWorkerThreadMax()

◆ TmThreadsInitThreadsTimestamp()

◆ TmThreadsInjectFlowById()

◆ TmThreadsListThreads()

◆ TmThreadSpawn()

◆ TmThreadsProcessDecodePseudoPackets()

◆ TmThreadsRegisterThread()

◆ TmThreadsSealThreads()

◆ TmThreadsSetFlag()

◆ TmThreadsSetThreadTimestamp()

◆ TmThreadsSlotVarRun()

◆ TmThreadsTimeSubsysIsReady()

◆ TmThreadsUnregisterThread()

◆ TmThreadsUnsealThreads()

◆ TmThreadsUnsetFlag()

◆ TmThreadsWaitForUnpause()

◆ TmThreadTimeoutLoop()

◆ TmThreadWaitForFlag()

◆ TmThreadWaitOnThreadInit()

◆ TmThreadWaitOnThreadRunning()

Variable Documentation

◆ in_use

◆ name

◆ spin

◆ sys_sec_stamp

◆ Threads

◆ tv

◆ tv_root

◆ tv_root_lock

◆ type

◆ attribute()