#include "suricata.h"
#include "tm-threads.h"
#include "output-packet.h"
#include "output-tx.h"
#include "output-file.h"
#include "output-filedata.h"
#include "output-flow.h"
#include "output-streaming.h"
#include "output-stats.h"

Include dependency graph for output.h:

Data Structures
struct	OutputInitResult_

struct	OutputModule_

Macros
#define	DEFAULT_LOG_MODE_APPEND "yes"

#define	DEFAULT_LOG_FILETYPE "regular"

Typedefs
typedef struct OutputInitResult_	OutputInitResult

typedef OutputInitResult(*	OutputInitFunc) (ConfNode *)

typedef OutputInitResult(*	OutputInitSubFunc) (ConfNode , OutputCtx )

typedef TmEcode(*	OutputLogFunc) (ThreadVars , Packet , void *)

typedef uint32_t(*	OutputGetActiveCountFunc) (void)

typedef struct OutputModule_	OutputModule

Functions
typedef	TAILQ_HEAD (OutputModuleList_, OutputModule_) OutputModuleList

void	OutputRegisterModule (const char , const char , OutputInitFunc)

void	OutputRegisterPacketModule (LoggerId id, const char name, const char conf_name, OutputInitFunc InitFunc, PacketLogger LogFunc, PacketLogCondition ConditionFunc, ThreadInitFunc, ThreadDeinitFunc, ThreadExitPrintStatsFunc)
	Register a packet output module. More...

void	OutputRegisterPacketSubModule (LoggerId id, const char parent_name, const char name, const char *conf_name, OutputInitSubFunc InitFunc, PacketLogger LogFunc, PacketLogCondition ConditionFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a packet output sub-module. More...

void	OutputRegisterTxModule (LoggerId id, const char name, const char conf_name, OutputInitFunc InitFunc, AppProto alproto, TxLogger TxLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a tx output module. More...

void	OutputRegisterTxSubModule (LoggerId id, const char parent_name, const char name, const char *conf_name, OutputInitSubFunc InitFunc, AppProto alproto, TxLogger TxLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)

void	OutputRegisterTxModuleWithCondition (LoggerId id, const char name, const char conf_name, OutputInitFunc InitFunc, AppProto alproto, TxLogger TxLogFunc, TxLoggerCondition TxLogCondition, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a tx output module with condition. More...

void	OutputRegisterTxSubModuleWithCondition (LoggerId id, const char parent_name, const char name, const char *conf_name, OutputInitSubFunc InitFunc, AppProto alproto, TxLogger TxLogFunc, TxLoggerCondition TxLogCondition, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)

void	OutputRegisterTxModuleWithProgress (LoggerId id, const char name, const char conf_name, OutputInitFunc InitFunc, AppProto alproto, TxLogger TxLogFunc, int tc_log_progress, int ts_log_progress, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a tx output module with progress. More...

void	OutputRegisterTxSubModuleWithProgress (LoggerId id, const char parent_name, const char name, const char *conf_name, OutputInitSubFunc InitFunc, AppProto alproto, TxLogger TxLogFunc, int tc_log_progress, int ts_log_progress, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)

void	OutputRegisterFileModule (LoggerId id, const char name, const char conf_name, OutputInitFunc InitFunc, FileLogger FileLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a file output module. More...

void	OutputRegisterFileSubModule (LoggerId id, const char parent_name, const char name, const char *conf_name, OutputInitSubFunc InitFunc, FileLogger FileLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a file output sub-module. More...

void	OutputRegisterFiledataModule (LoggerId id, const char name, const char conf_name, OutputInitFunc InitFunc, FiledataLogger FiledataLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a file data output module. More...

void	OutputRegisterFiledataSubModule (LoggerId, const char parent_name, const char name, const char *conf_name, OutputInitSubFunc InitFunc, FiledataLogger FiledataLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a file data output sub-module. More...

void	OutputRegisterFlowModule (LoggerId id, const char name, const char conf_name, OutputInitFunc InitFunc, FlowLogger FlowLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a flow output module. More...

void	OutputRegisterFlowSubModule (LoggerId id, const char parent_name, const char name, const char *conf_name, OutputInitSubFunc InitFunc, FlowLogger FlowLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a flow output sub-module. More...

void	OutputRegisterStreamingModule (LoggerId id, const char name, const char conf_name, OutputInitFunc InitFunc, StreamingLogger StreamingLogFunc, enum OutputStreamingType stream_type, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a streaming data output module. More...

void	OutputRegisterStreamingSubModule (LoggerId id, const char parent_name, const char name, const char *conf_name, OutputInitSubFunc InitFunc, StreamingLogger StreamingLogFunc, enum OutputStreamingType stream_type, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a streaming data output sub-module. More...

void	OutputRegisterStatsModule (LoggerId id, const char name, const char conf_name, OutputInitFunc InitFunc, StatsLogger StatsLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a stats data output module. More...

void	OutputRegisterStatsSubModule (LoggerId id, const char parent_name, const char name, const char *conf_name, OutputInitSubFunc InitFunc, StatsLogger StatsLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
	Register a stats data output sub-module. More...

OutputModule *	OutputGetModuleByConfName (const char *name)
	Get an output module by name. More...

void	OutputDeregisterAll (void)
	Deregister all modules. Useful for a memory clean exit. More...

int	OutputDropLoggerEnable (void)

void	OutputDropLoggerDisable (void)

void	OutputRegisterFileRotationFlag (int *flag)
	Register a flag for file rotation notification. More...

void	OutputUnregisterFileRotationFlag (int *flag)
	Unregister a file rotation flag. More...

void	OutputNotifyFileRotation (void)
	Notifies all registered file rotation notification flags. More...

void	OutputRegisterRootLogger (ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats, OutputLogFunc LogFunc, OutputGetActiveCountFunc ActiveCntFunc)

void	TmModuleLoggerRegister (void)

TmEcode	OutputLoggerLog (ThreadVars , Packet , void *)

TmEcode	OutputLoggerThreadInit (ThreadVars , const void , void **)

TmEcode	OutputLoggerThreadDeinit (ThreadVars , void )

void	OutputLoggerExitPrintStats (ThreadVars , void )

void	OutputSetupActiveLoggers (void)

void	OutputClearActiveLoggers (void)

Variables
OutputModuleList	output_modules

Detailed Description

Author: Endace Technology Limited, Jason Ish jason.nosp@m..ish.nosp@m.@enda.nosp@m.ce.c.nosp@m.om

Definition in file output.h.

Macro Definition Documentation

◆ DEFAULT_LOG_FILETYPE

#define DEFAULT_LOG_FILETYPE "regular"

Definition at line 32 of file output.h.

◆ DEFAULT_LOG_MODE_APPEND

#define DEFAULT_LOG_MODE_APPEND "yes"

Definition at line 31 of file output.h.

Typedef Documentation

◆ OutputGetActiveCountFunc

typedef uint32_t(* OutputGetActiveCountFunc) (void)

Definition at line 49 of file output.h.

◆ OutputInitFunc

typedef OutputInitResult(* OutputInitFunc) (ConfNode *)

Definition at line 46 of file output.h.

◆ OutputInitResult

typedef struct OutputInitResult_ OutputInitResult

◆ OutputInitSubFunc

typedef OutputInitResult(* OutputInitSubFunc) (ConfNode *, OutputCtx *)

Definition at line 47 of file output.h.

◆ OutputLogFunc

typedef TmEcode(* OutputLogFunc) (ThreadVars *, Packet *, void *)

Definition at line 48 of file output.h.

◆ OutputModule

typedef struct OutputModule_ OutputModule

Function Documentation

◆ OutputClearActiveLoggers()

void OutputClearActiveLoggers ( void )

Definition at line 1057 of file output.c.

References SCFree, TAILQ_FIRST, and TAILQ_REMOVE.

◆ OutputDeregisterAll()

void OutputDeregisterAll ( void )

Deregister all modules. Useful for a memory clean exit.

Definition at line 847 of file output.c.

References output_modules, SCFree, TAILQ_FIRST, and TAILQ_REMOVE.

◆ OutputDropLoggerDisable()

void OutputDropLoggerDisable ( void )

Definition at line 867 of file output.c.

◆ OutputDropLoggerEnable()

int OutputDropLoggerEnable ( void )

Definition at line 859 of file output.c.

◆ OutputGetModuleByConfName()

OutputModule* OutputGetModuleByConfName ( const char * conf_name )

Get an output module by name.

Return values

The	OutputModule with the given name or NULL if no output module with the given name is registered.

Definition at line 832 of file output.c.

References OutputModule_::conf_name, output_modules, and TAILQ_FOREACH.

◆ OutputLoggerExitPrintStats()

void OutputLoggerExitPrintStats	(	ThreadVars *	,
		void *
	)

Definition at line 997 of file output.c.

◆ OutputLoggerLog()

TmEcode OutputLoggerLog	(	ThreadVars *	,
		Packet *	,
		void *
	)

Definition at line 925 of file output.c.

◆ OutputLoggerThreadDeinit()

TmEcode OutputLoggerThreadDeinit	(	ThreadVars *	,
		void *
	)

Definition at line 971 of file output.c.

References TM_ECODE_FAILED.

◆ OutputLoggerThreadInit()

TmEcode OutputLoggerThreadInit	(	ThreadVars *	,
		const void *	,
		void **
	)

Definition at line 940 of file output.c.

◆ OutputNotifyFileRotation()

void OutputNotifyFileRotation ( void )

Notifies all registered file rotation notification flags.

Definition at line 918 of file output.c.

References OutputFileRolloverFlag, and TAILQ_FOREACH.

◆ OutputRegisterFiledataModule()

void OutputRegisterFiledataModule	(	LoggerId	id,
		const char *	name,
		const char *	conf_name,
		OutputInitFunc	InitFunc,
		FiledataLogger	FiledataLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a file data output module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 509 of file output.c.

References OutputModule_::conf_name, OutputModule_::FiledataLogFunc, OutputModule_::InitFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

Referenced by OutputFilestoreRegister().

Here is the caller graph for this function:

◆ OutputRegisterFiledataSubModule()

void OutputRegisterFiledataSubModule	(	LoggerId	id,
		const char *	parent_name,
		const char *	name,
		const char *	conf_name,
		OutputInitSubFunc	InitFunc,
		FiledataLogger	FiledataLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a file data output sub-module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 549 of file output.c.

References OutputModule_::conf_name, OutputModule_::FiledataLogFunc, OutputModule_::InitSubFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, OutputModule_::parent_name, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

◆ OutputRegisterFileModule()

void OutputRegisterFileModule	(	LoggerId	id,
		const char *	name,
		const char *	conf_name,
		OutputInitFunc	InitFunc,
		FileLogger	FileLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a file output module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 429 of file output.c.

References OutputModule_::conf_name, OutputModule_::FileLogFunc, OutputModule_::InitFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

◆ OutputRegisterFileRotationFlag()

void OutputRegisterFileRotationFlag ( int * flag )

Register a flag for file rotation notification.

Parameters

flag	A pointer that will be set to 1 when file rotation is requested.

Definition at line 879 of file output.c.

References OutputFileRolloverFlag, SC_ERR_MEM_ALLOC, SCCalloc, SCLogError, TAILQ_INSERT_TAIL, and unlikely.

◆ OutputRegisterFileSubModule()

void OutputRegisterFileSubModule	(	LoggerId	id,
		const char *	parent_name,
		const char *	name,
		const char *	conf_name,
		OutputInitSubFunc	InitFunc,
		FileLogger	FileLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a file output sub-module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 468 of file output.c.

References OutputModule_::conf_name, OutputModule_::FileLogFunc, OutputModule_::InitSubFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, OutputModule_::parent_name, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

Referenced by JsonFileLogRegister().

Here is the caller graph for this function:

◆ OutputRegisterFlowModule()

void OutputRegisterFlowModule	(	LoggerId	id,
		const char *	name,
		const char *	conf_name,
		OutputInitFunc	InitFunc,
		FlowLogger	FlowLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a flow output module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 590 of file output.c.

References OutputModule_::conf_name, OutputModule_::FlowLogFunc, OutputModule_::InitFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

Referenced by JsonFlowLogRegister(), and JsonNetFlowLogRegister().

Here is the caller graph for this function:

◆ OutputRegisterFlowSubModule()

void OutputRegisterFlowSubModule	(	LoggerId	id,
		const char *	parent_name,
		const char *	name,
		const char *	conf_name,
		OutputInitSubFunc	InitFunc,
		FlowLogger	FlowLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a flow output sub-module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 629 of file output.c.

References OutputModule_::conf_name, OutputModule_::FlowLogFunc, OutputModule_::InitSubFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, OutputModule_::parent_name, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

◆ OutputRegisterModule()

void OutputRegisterModule	(	const char *	,
		const char *	,
		OutputInitFunc
	)

Referenced by OutputJsonRegister().

Here is the caller graph for this function:

◆ OutputRegisterPacketModule()

void OutputRegisterPacketModule	(	LoggerId	id,
		const char *	name,
		const char *	conf_name,
		OutputInitFunc	InitFunc,
		PacketLogger	PacketLogFunc,
		PacketLogCondition	PacketConditionFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a packet output module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 171 of file output.c.

References OutputModule_::conf_name, OutputModule_::InitFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, OutputModule_::PacketConditionFunc, OutputModule_::PacketLogFunc, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

Referenced by AlertDebugLogRegister(), AlertFastLogRegister(), AlertPreludeRegister(), AlertSyslogRegister(), JsonAlertLogRegister(), JsonDropLogRegister(), JsonMetadataLogRegister(), and PcapLogRegister().

Here is the caller graph for this function:

◆ OutputRegisterPacketSubModule()

void OutputRegisterPacketSubModule	(	LoggerId	id,
		const char *	parent_name,
		const char *	name,
		const char *	conf_name,
		OutputInitSubFunc	InitFunc,
		PacketLogger	PacketLogFunc,
		PacketLogCondition	PacketConditionFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a packet output sub-module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 212 of file output.c.

References OutputModule_::conf_name, OutputModule_::InitSubFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, OutputModule_::PacketConditionFunc, OutputModule_::PacketLogFunc, OutputModule_::parent_name, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

Referenced by JsonAnomalyLogRegister().

Here is the caller graph for this function:

◆ OutputRegisterRootLogger()

void OutputRegisterRootLogger	(	ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats,
		OutputLogFunc	LogFunc,
		OutputGetActiveCountFunc	ActiveCntFunc
	)

Definition at line 1011 of file output.c.

References RootLogger_::ActiveCntFunc, BUG_ON, FatalError, RootLogger_::LogFunc, SC_ERR_MEM_ALLOC, SCCalloc, TAILQ_INSERT_TAIL, RootLogger_::ThreadDeinit, RootLogger_::ThreadExitPrintStats, and RootLogger_::ThreadInit.

Referenced by OutputFiledataLoggerRegister(), OutputFileLoggerRegister(), OutputPacketLoggerRegister(), OutputStreamingLoggerRegister(), and OutputTxLoggerRegister().

Here is the caller graph for this function:

◆ OutputRegisterStatsModule()

void OutputRegisterStatsModule	(	LoggerId	id,
		const char *	name,
		const char *	conf_name,
		OutputInitFunc	InitFunc,
		StatsLogger	StatsLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a stats data output module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 754 of file output.c.

References OutputModule_::conf_name, OutputModule_::InitFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, OutputModule_::StatsLogFunc, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

Referenced by JsonStatsLogRegister(), and LogStatsLogRegister().

Here is the caller graph for this function:

◆ OutputRegisterStatsSubModule()

void OutputRegisterStatsSubModule	(	LoggerId	id,
		const char *	parent_name,
		const char *	name,
		const char *	conf_name,
		OutputInitSubFunc	InitFunc,
		StatsLogger	StatsLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a stats data output sub-module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 793 of file output.c.

References OutputModule_::conf_name, OutputModule_::InitSubFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, OutputModule_::parent_name, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, OutputModule_::StatsLogFunc, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

◆ OutputRegisterStreamingModule()

void OutputRegisterStreamingModule	(	LoggerId	id,
		const char *	name,
		const char *	conf_name,
		OutputInitFunc	InitFunc,
		StreamingLogger	StreamingLogFunc,
		enum OutputStreamingType	stream_type,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a streaming data output module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 670 of file output.c.

References OutputModule_::conf_name, OutputModule_::InitFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, OutputModule_::stream_type, OutputModule_::StreamingLogFunc, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

Referenced by LogTcpDataLogRegister().

Here is the caller graph for this function:

◆ OutputRegisterStreamingSubModule()

void OutputRegisterStreamingSubModule	(	LoggerId	id,
		const char *	parent_name,
		const char *	name,
		const char *	conf_name,
		OutputInitSubFunc	InitFunc,
		StreamingLogger	StreamingLogFunc,
		enum OutputStreamingType	stream_type,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a streaming data output sub-module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 712 of file output.c.

References OutputModule_::conf_name, OutputModule_::InitSubFunc, OutputModule_::logger_id, OutputModule_::name, output_modules, OutputModule_::parent_name, SC_ERR_FATAL, SCCalloc, SCLogDebug, SCLogError, OutputModule_::stream_type, OutputModule_::StreamingLogFunc, TAILQ_INSERT_TAIL, OutputModule_::ThreadDeinit, OutputModule_::ThreadExitPrintStats, OutputModule_::ThreadInit, and unlikely.

◆ OutputRegisterTxModule()

void OutputRegisterTxModule	(	LoggerId	id,
		const char *	name,
		const char *	conf_name,
		OutputInitFunc	InitFunc,
		AppProto	alproto,
		TxLogger	TxLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a tx output module.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 399 of file output.c.

Referenced by JsonHttpLogRegister(), JsonSmtpLogRegister(), and LogHttpLogRegister().

Here is the caller graph for this function:

◆ OutputRegisterTxModuleWithCondition()

void OutputRegisterTxModuleWithCondition	(	LoggerId	id,
		const char *	name,
		const char *	conf_name,
		OutputInitFunc	InitFunc,
		AppProto	alproto,
		TxLogger	TxLogFunc,
		TxLoggerCondition	TxLogCondition,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a tx output module with condition.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 337 of file output.c.

Referenced by JsonSshLogRegister(), and LogTlsStoreRegister().

Here is the caller graph for this function:

◆ OutputRegisterTxModuleWithProgress()

void OutputRegisterTxModuleWithProgress	(	LoggerId	id,
		const char *	name,
		const char *	conf_name,
		OutputInitFunc	InitFunc,
		AppProto	alproto,
		TxLogger	TxLogFunc,
		int	tc_log_progress,
		int	ts_log_progress,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Register a tx output module with progress.

This function will register an output module so it can be configured with the configuration file.

Return values

Returns 0 on success, -1 on failure.

Definition at line 368 of file output.c.

Referenced by JsonTlsLogRegister(), and LogTlsLogRegister().

Here is the caller graph for this function:

◆ OutputRegisterTxSubModule()

void OutputRegisterTxSubModule	(	LoggerId	id,
		const char *	parent_name,
		const char *	name,
		const char *	conf_name,
		OutputInitSubFunc	InitFunc,
		AppProto	alproto,
		TxLogger	TxLogFunc,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Definition at line 410 of file output.c.

Referenced by JsonDHCPLogRegister(), JsonFTPLogRegister(), JsonIKEv2LogRegister(), JsonKRB5LogRegister(), JsonNFSLogRegister(), JsonRdpLogRegister(), JsonRFBLogRegister(), JsonSIPLogRegister(), JsonSMBLogRegister(), JsonSNMPLogRegister(), JsonTemplateLogRegister(), JsonTemplateRustLogRegister(), and JsonTFTPLogRegister().

Here is the caller graph for this function:

◆ OutputRegisterTxSubModuleWithCondition()

void OutputRegisterTxSubModuleWithCondition	(	LoggerId	id,
		const char *	parent_name,
		const char *	name,
		const char *	conf_name,
		OutputInitSubFunc	InitFunc,
		AppProto	alproto,
		TxLogger	TxLogFunc,
		TxLoggerCondition	TxLogCondition,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Definition at line 348 of file output.c.

◆ OutputRegisterTxSubModuleWithProgress()

void OutputRegisterTxSubModuleWithProgress	(	LoggerId	id,
		const char *	parent_name,
		const char *	name,
		const char *	conf_name,
		OutputInitSubFunc	InitFunc,
		AppProto	alproto,
		TxLogger	TxLogFunc,
		int	tc_log_progress,
		int	ts_log_progress,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

Definition at line 379 of file output.c.

Referenced by JsonDNP3LogRegister().

Here is the caller graph for this function:

◆ OutputSetupActiveLoggers()

void OutputSetupActiveLoggers ( void )

Definition at line 1044 of file output.c.

References TAILQ_FIRST.

◆ OutputUnregisterFileRotationFlag()

void OutputUnregisterFileRotationFlag ( int * flag )

Unregister a file rotation flag.

Note that it is safe to call this function with a flag that may not have been registered, in which case this function won't do anything.

Parameters

flag	A pointer that has been previously registered for file rotation notifications.

Definition at line 901 of file output.c.

References next, OutputFileRolloverFlag, SCFree, TAILQ_FIRST, TAILQ_NEXT, and TAILQ_REMOVE.

Referenced by LogFileFreeCtx().

Here is the caller graph for this function:

◆ TAILQ_HEAD()

typedef TAILQ_HEAD	(	OutputModuleList_	,
		OutputModule_
	)

◆ TmModuleLoggerRegister()

void TmModuleLoggerRegister ( void )

Definition at line 1066 of file output.c.

References OutputRegisterLoggers(), and OutputRegisterRootLoggers().

Referenced by RegisterAllModules().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ output_modules

OutputModuleList output_modules

Referenced by OutputDeregisterAll(), OutputGetModuleByConfName(), OutputRegisterFiledataModule(), OutputRegisterFiledataSubModule(), OutputRegisterFileModule(), OutputRegisterFileSubModule(), OutputRegisterFlowModule(), OutputRegisterFlowSubModule(), OutputRegisterPacketModule(), OutputRegisterPacketSubModule(), OutputRegisterStatsModule(), OutputRegisterStatsSubModule(), OutputRegisterStreamingModule(), and OutputRegisterStreamingSubModule().

Data Structures

Macros

Typedefs

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ DEFAULT_LOG_FILETYPE

◆ DEFAULT_LOG_MODE_APPEND

Typedef Documentation

◆ OutputGetActiveCountFunc

◆ OutputInitFunc

◆ OutputInitResult

◆ OutputInitSubFunc

◆ OutputLogFunc

◆ OutputModule

Function Documentation

◆ OutputClearActiveLoggers()

◆ OutputDeregisterAll()

◆ OutputDropLoggerDisable()

◆ OutputDropLoggerEnable()

◆ OutputGetModuleByConfName()

◆ OutputLoggerExitPrintStats()

◆ OutputLoggerLog()

◆ OutputLoggerThreadDeinit()

◆ OutputLoggerThreadInit()

◆ OutputNotifyFileRotation()

◆ OutputRegisterFiledataModule()

◆ OutputRegisterFiledataSubModule()

◆ OutputRegisterFileModule()

◆ OutputRegisterFileRotationFlag()

◆ OutputRegisterFileSubModule()

◆ OutputRegisterFlowModule()

◆ OutputRegisterFlowSubModule()

◆ OutputRegisterModule()

◆ OutputRegisterPacketModule()

◆ OutputRegisterPacketSubModule()

◆ OutputRegisterRootLogger()

◆ OutputRegisterStatsModule()

◆ OutputRegisterStatsSubModule()

◆ OutputRegisterStreamingModule()

◆ OutputRegisterStreamingSubModule()

◆ OutputRegisterTxModule()

◆ OutputRegisterTxModuleWithCondition()

◆ OutputRegisterTxModuleWithProgress()

◆ OutputRegisterTxSubModule()

◆ OutputRegisterTxSubModuleWithCondition()

◆ OutputRegisterTxSubModuleWithProgress()

◆ OutputSetupActiveLoggers()

◆ OutputUnregisterFileRotationFlag()

◆ TAILQ_HEAD()

◆ TmModuleLoggerRegister()

Variable Documentation

◆ output_modules