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(*	FileLogger) (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 More...
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	OutputRegisterFileLogger (LoggerId id, const char *name, FileLogger LogFunc, OutputCtx *, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, ThreadExitPrintStatsFunc ThreadExitPrintStats)
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

FileLogger

typedef int(* FileLogger) (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.

OutputFileLoggerThreadData

typedef struct OutputFileLoggerThreadData_ OutputFileLoggerThreadData

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

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 101 of file output-file.c.

References FILE_LOGGED, FILE_STATE_CLOSED, FILE_STATE_OPENED, FILE_STATE_TRUNCATED, FileApplyTxFlags(), FileForceMagic(), File_::flags, FileContainer_::head, File_::next, SCLogDebug, and File_::state.

Here is the call graph for this function:

OutputFileLoggerRegister()

void OutputFileLoggerRegister

(

void

)

Definition at line 241 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 217 of file output-file.c.

References OutputFileLoggerThreadData_::store.

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 169 of file output-file.c.

References SCCalloc, SCFree, SCLogDebug, and TM_ECODE_FAILED.

OutputFileShutdown()

void OutputFileShutdown

(

void

)

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

OutputRegisterFileLogger()

int OutputRegisterFileLogger	(	LoggerId	id,
		const char *	name,
		FileLogger	LogFunc,
		OutputCtx *	,
		ThreadInitFunc	ThreadInit,
		ThreadDeinitFunc	ThreadDeinit,
		ThreadExitPrintStatsFunc	ThreadExitPrintStats
	)

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

References OutputFileLogger_::LogFunc, OutputFileLogger_::logger_id, OutputFileLogger_::name, OutputFileLogger_::output_ctx, SCMalloc, OutputFileLogger_::ThreadDeinit, OutputFileLogger_::ThreadExitPrintStats, and OutputFileLogger_::ThreadInit.