#include "suricata-common.h"
#include "output.h"
#include "output-tx.h"
#include "stream.h"
#include "app-layer.h"
#include "app-layer-parser.h"
#include "util-config.h"
#include "util-profiling.h"
#include "util-validate.h"

Include dependency graph for output-tx.c:

Data Structures
struct	OutputTxLoggerThreadData_

struct	OutputTxLogger_

struct	Ctx

Typedefs
typedef struct OutputTxLoggerThreadData_	OutputTxLoggerThreadData

typedef struct OutputTxLogger_	OutputTxLogger

Functions
int	SCOutputRegisterTxLogger (LoggerId id, const char name, AppProto alproto, TxLogger LogFunc, void initdata, int tc_log_progress, int ts_log_progress, TxLoggerCondition LogCondition, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit)
	Register a transaction logger.

void	OutputTxLoggerRegister (void)

void	OutputTxShutdown (void)

Variables
bool	g_file_logger_enabled

bool	g_filedata_logger_enabled

Detailed Description

Author: Victor Julien victo.nosp@m.r@in.nosp@m.linia.nosp@m.c.ne.nosp@m.t

AppLayer TX Logger Output registration functions

Definition in file output-tx.c.

Typedef Documentation

◆ OutputTxLogger

typedef struct OutputTxLogger_ OutputTxLogger

◆ OutputTxLoggerThreadData

typedef struct OutputTxLoggerThreadData_ OutputTxLoggerThreadData

per thread data for this module, contains a list of per thread data for the packet loggers.

Function Documentation

◆ OutputTxLoggerRegister()

void OutputTxLoggerRegister ( void )

Internal function: private API.

Definition at line 650 of file output-tx.c.

References BUG_ON, FatalError, g_alproto_max, OutputRegisterRootLogger(), SCCalloc, and unlikely.

Referenced by OutputRegisterRootLoggers().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OutputTxShutdown()

void OutputTxShutdown ( void )

Internal function: private API.

Definition at line 661 of file output-tx.c.

References g_alproto_max, OutputTxLogger_::next, and SCFree.

Referenced by GlobalsDestroy(), and RunModeShutDown().

Here is the caller graph for this function:

◆ SCOutputRegisterTxLogger()

int SCOutputRegisterTxLogger	(	LoggerId	id,
		const char *	name,
		AppProto	alproto,
		TxLogger	LogFunc,
		void *	initdata,
		int	tc_log_progress,
		int	ts_log_progress,
		TxLoggerCondition	LogCondition,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit
	)

Register a transaction logger.

Parameters

logger_id	An ID used to distinguish this logger from others while profiling. For transaction logging this is only used for some internal state tracking.
name	An informational name for this logger. Used for debugging.
alproto	The application layer protocol this logger is for, for example ALPROTO_DNS.
LogFunc	A pointer to the logging function.
initdata	Initialization data that will be provided to the ThreadInit callback.
tc_log_progress	The to_client progress state required for the log function to be called.
ts_log_progress	The to_server progress state required for the log function to be called.
LogCondition	A pointer to a function that will be called before the log function to test if the log function should be called.
ThreadInitFunc	Callback a thread initialization function, initdata will be provided.
ThreadDeinitFunc	Callback to a thread de-initialization function for cleanup.

Definition at line 66 of file output-tx.c.

References OutputTxLogger_::alproto, ALPROTO_UNKNOWN, AppLayerParserGetStateProgressCompletionStatus(), AppLayerParserIsEnabled(), AppProtoToString(), FatalError, g_alproto_max, id, OutputTxLogger_::id, OutputTxLogger_::initdata, OutputTxLogger_::LogCondition, OutputTxLogger_::LogFunc, OutputTxLogger_::logger_id, OutputTxLogger_::name, name, OutputTxLogger_::next, SCCalloc, SCLogDebug, SCLogError, OutputTxLogger_::tc_log_progress, OutputTxLogger_::ThreadDeinit, OutputTxLogger_::ThreadInit, OutputTxLogger_::ts_log_progress, and unlikely.

Here is the call graph for this function:

Variable Documentation

◆ g_file_logger_enabled

bool g_file_logger_enabled

extern

Definition at line 39 of file output-file.c.

◆ g_filedata_logger_enabled

bool g_filedata_logger_enabled