output-file.h File Reference

#include "rust.h"

Include dependency graph for output-file.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	OutputFileLoggerThreadData_

Typedefs
typedef struct OutputFileLoggerThreadData_	OutputFileLoggerThreadData
typedef int(*	SCFileLogger) (ThreadVars *, void *thread_data, const Packet *, const File *, void *tx, const uint64_t tx_id, uint8_t direction)

Functions
TmEcode	OutputFileLogThreadInit (ThreadVars *tv, OutputFileLoggerThreadData **data)
	thread init for the file logger This will run the thread init functions for the individual registered loggers
TmEcode	OutputFileLogThreadDeinit (ThreadVars *tv, OutputFileLoggerThreadData *thread_data)
void	OutputFileLogFfc (ThreadVars *tv, OutputFileLoggerThreadData *op_thread_data, Packet *p, FileContainer *ffc, void *txv, const uint64_t tx_id, AppLayerTxData *txd, const bool file_close, const bool file_trunc, uint8_t dir)
int	SCOutputRegisterFileLogger (LoggerId id, const char *name, SCFileLogger LogFunc, void *initdata, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit)
	Register a file logger.
void	OutputFileLoggerRegister (void)
void	OutputFileShutdown (void)

Detailed Description

Author

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

AppLayer File Logger Output registration functions

Definition in file output-file.h.

Typedef Documentation

OutputFileLoggerThreadData

typedef struct OutputFileLoggerThreadData_ OutputFileLoggerThreadData

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

SCFileLogger

typedef int(* SCFileLogger) (ThreadVars *, void *thread_data, const Packet *, const File *, void *tx, const uint64_t tx_id, uint8_t direction)

file logger function pointer type

Definition at line 48 of file output-file.h.

Function Documentation

OutputFileLogFfc()

void OutputFileLogFfc	(	ThreadVars *	tv,
		OutputFileLoggerThreadData *	op_thread_data,
		Packet *	p,
		FileContainer *	ffc,
		void *	txv,
		const uint64_t	tx_id,
		AppLayerTxData *	txd,
		const bool	file_close,
		const bool	file_trunc,
		uint8_t	dir
	)

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

References DEBUG_VALIDATE_BUG_ON, FILE_LOGGED, FILE_STATE_CLOSED, FILE_STATE_OPENED, FILE_STATE_TRUNCATED, FileApplyTxFlags(), FileForceMagic(), Packet_::flow, FileContainer_::head, OutputFileLogger_::LogFunc, OutputFileLogger_::logger_id, OutputFileLogger_::next, OutputLoggerThreadStore_::next, PACKET_PROFILING_LOGGER_END, PACKET_PROFILING_LOGGER_START, SCLogDebug, OutputFileLoggerThreadData_::store, OutputLoggerThreadStore_::thread_data, and tv.

Here is the call graph for this function:

OutputFileLoggerRegister()

void OutputFileLoggerRegister

(

void

)

Internal function: private API.

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

Referenced by OutputRegisterRootLoggers().

Here is the caller graph for this function:

OutputFileLogThreadDeinit()

TmEcode OutputFileLogThreadDeinit	(	ThreadVars *	tv,
		OutputFileLoggerThreadData *	thread_data
	)

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

References OutputFileLogger_::next, OutputLoggerThreadStore_::next, SCFree, OutputFileLoggerThreadData_::store, OutputLoggerThreadStore_::thread_data, OutputFileLogger_::ThreadDeinit, TM_ECODE_OK, and tv.

OutputFileLogThreadInit()

TmEcode OutputFileLogThreadInit	(	ThreadVars *	tv,
		OutputFileLoggerThreadData **	data
	)

thread init for the file logger This will run the thread init functions for the individual registered loggers

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

References BUG_ON, OutputFileLogger_::initdata, OutputFileLogger_::name, OutputFileLogger_::next, OutputLoggerThreadStore_::next, SCCalloc, SCFree, SCLogDebug, OutputFileLoggerThreadData_::store, OutputFileLogger_::ThreadInit, TM_ECODE_FAILED, TM_ECODE_OK, ts, and tv.

OutputFileShutdown()

void OutputFileShutdown

(

void

)

Internal function: private API.

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

References OutputFileLogger_::next, and SCFree.

Referenced by RunModeShutDown().

Here is the caller graph for this function:

SCOutputRegisterFileLogger()

int SCOutputRegisterFileLogger	(	LoggerId	id,
		const char *	name,
		SCFileLogger	LogFunc,
		void *	initdata,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit
	)

Register a file logger.

Parameters

logger_id	An ID used to distinguish this logger from others while profiling.
name	An informational name for this logger. Used only for debugging.
LogFunc	A function that will be called to log each file to be logged.
initdata	Initialization data that will pass to the ThreadInitFunc.
ThreadInitFunc	Thread initialization function.
ThreadDeinitFunc	Thread de-initialization function.

Return values

0	on success, -1 on failure.

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

References g_file_logger_enabled, id, OutputFileLogger_::initdata, OutputFileLogger_::LogFunc, OutputFileLogger_::logger_id, OutputFileLogger_::name, name, OutputFileLogger_::next, SCCalloc, SCLogDebug, OutputFileLogger_::ThreadDeinit, and OutputFileLogger_::ThreadInit.