#include "suricata-common.h"
#include "util-logopenfile.h"
#include "suricata.h"
#include "conf.h"
#include "output.h"
#include "util-byte.h"
#include "util-conf.h"
#include "util-path.h"
#include "util-misc.h"
#include "util-time.h"
#include "log-flush.h"

Include dependency graph for util-logopenfile.c:

Macros
#define	LOGFILE_NAME_MAX 255

Functions
bool	SCLogOpenThreadedFile (const char log_path, const char append, LogFileCtx *parent_ctx)

int	SCConfLogOpenGeneric (SCConfNode conf, LogFileCtx log_ctx, const char *default_filename, int rotate)
	open a generic output "log file", which may be a regular file or a socket More...

int	SCConfLogReopen (LogFileCtx *log_ctx)
	Reopen a regular log file with the side-affect of truncating it. More...

LogFileCtx *	LogFileNewCtx (void)
	LogFileNewCtx() Get a new LogFileCtx. More...

LogFileCtx *	LogFileEnsureExists (ThreadId thread_id, LogFileCtx *parent_ctx)
	LogFileEnsureExists() Ensure a log file context for the thread exists. More...

int	LogFileFreeCtx (LogFileCtx *lf_ctx)
	LogFileFreeCtx() Destroy a LogFileCtx (Close the file and free memory) More...

void	LogFileFlush (LogFileCtx *file_ctx)

void	LogFileRegisterForFlush (LogFileCtx *ctx)
	Register a LogFileCtx for flush operations. More...

void	LogFileUnregisterForFlush (LogFileCtx *ctx)
	Unregister a LogFileCtx from flush operations. More...

void	LogFileFlushAll (void)
	Flush all registered LogFileCtx instances. More...

int	LogFileWrite (LogFileCtx file_ctx, MemBuffer buffer)

Detailed Description

Author: Mike Pomraning mpomr.nosp@m.anin.nosp@m.g@qua.nosp@m.lys..nosp@m.com

File-like output for logging: regular files and sockets.

Definition in file util-logopenfile.c.

Macro Definition Documentation

◆ LOGFILE_NAME_MAX

#define LOGFILE_NAME_MAX 255

Definition at line 50 of file util-logopenfile.c.

Function Documentation

◆ LogFileEnsureExists()

LogFileCtx* LogFileEnsureExists	(	ThreadId	thread_id,
		LogFileCtx *	parent_ctx
	)

LogFileEnsureExists() Ensure a log file context for the thread exists.

Parameters

parent_ctx

Return values

LogFileCtx * pointer if successful; NULL otherwise

Definition at line 773 of file util-logopenfile.c.

References LogThreadedFileCtx_::mutex, SCMutexLock, LogFileCtx_::threaded, and LogFileCtx_::threads.

Referenced by CreateEveThreadCtx(), and JsonLogThreadInit().

Here is the caller graph for this function:

◆ LogFileFlush()

void LogFileFlush ( LogFileCtx * file_ctx )

Definition at line 1012 of file util-logopenfile.c.

References LogFileCtx_::bytes_since_last_flush, LogFileCtx_::filename, LogFileCtx_::Flush, and SCLogDebug.

◆ LogFileFlushAll()

void LogFileFlushAll ( void )

Flush all registered LogFileCtx instances.

Called by the heartbeat thread to flush all active file-based loggers. Iterates through the flush list and calls LogFileFlush on each context.

Definition at line 1086 of file util-logopenfile.c.

References SCMutexLock.

◆ LogFileFreeCtx()

int LogFileFreeCtx ( LogFileCtx * lf_ctx )

LogFileFreeCtx() Destroy a LogFileCtx (Close the file and free memory)

Parameters

lf_ctx pointer to the OutputCtx

Return values

int	1 if successful, 0 if error

Definition at line 942 of file util-logopenfile.c.

References LogThreadedFileCtx_::append, BUG_ON, LogFileCtx_::Close, SCEveFileType_::Deinit, LogFileCtx_::filename, LogFileTypeCtx_::filetype, LogFileCtx_::filetype, LogFileCtx_::fp, LogFileCtx_::fp_mutex, HashTableFree(), LogThreadedFileCtx_::ht, LogFileTypeCtx_::init_data, LOGFILE_TYPE_FILETYPE, LOGFILE_TYPE_REDIS, LogFileUnregisterForFlush(), LogThreadedFileCtx_::mutex, OutputUnregisterFileRotationFlag(), LogFileCtx_::parent, LogFileCtx_::prefix, LogFileCtx_::prefix_len, LogFileCtx_::rotation_flag, SCFree, SCMutexDestroy, SCReturnInt, LogFileCtx_::sensor_name, LogFileTypeCtx_::thread_data, SCEveFileType_::ThreadDeinit, LogFileCtx_::threaded, LogFileCtx_::threads, and LogFileCtx_::type.

Referenced by AlertFastLogInitCtx(), LogHttpLogInitCtx(), and LogTcpDataLogInitCtx().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogFileNewCtx()

LogFileCtx* LogFileNewCtx ( void )

LogFileNewCtx() Get a new LogFileCtx.

Return values

LogFileCtx * pointer if successful, NULL if error

Definition at line 722 of file util-logopenfile.c.

References SCCalloc, and LogFileCtx_::Write.

Referenced by AlertFastLogInitCtx(), LogHttpLogInitCtx(), LogTcpDataLogInitCtx(), and OutputJsonInitCtx().

Here is the caller graph for this function:

◆ LogFileRegisterForFlush()

void LogFileRegisterForFlush ( LogFileCtx * ctx )

Register a LogFileCtx for flush operations.

Adds a LogFileCtx to the global flush list so the heartbeat thread can flush it directly without using pseudo packets.

Parameters

ctx	The LogFileCtx to register (must be LOGFILE_TYPE_FILE)

Definition at line 1026 of file util-logopenfile.c.

References LogFileFlushEntry_::ctx, ctx, LOGFILE_TYPE_FILE, OutputFlushInterval(), SCLogDebug, SCLogError, SCMalloc, and SCMutexLock.

Here is the call graph for this function:

◆ LogFileUnregisterForFlush()

void LogFileUnregisterForFlush ( LogFileCtx * ctx )

Unregister a LogFileCtx from flush operations.

Removes a LogFileCtx from the global flush list.

Parameters

ctx	The LogFileCtx to unregister

Definition at line 1057 of file util-logopenfile.c.

References ctx, OutputFlushInterval(), SCLogDebug, and SCMutexLock.

Referenced by LogFileFreeCtx().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LogFileWrite()

int LogFileWrite	(	LogFileCtx *	file_ctx,
		MemBuffer *	buffer
	)

Definition at line 1098 of file util-logopenfile.c.

References LogFileTypeCtx_::filetype, LogFileCtx_::filetype, LogFileCtx_::fp_mutex, LogFileTypeCtx_::init_data, LOGFILE_TYPE_FILE, LOGFILE_TYPE_FILETYPE, LOGFILE_TYPE_REDIS, LOGFILE_TYPE_UNIX_DGRAM, LOGFILE_TYPE_UNIX_STREAM, MEMBUFFER_BUFFER, MEMBUFFER_OFFSET, MemBufferWriteString(), SCMutexLock, SCMutexUnlock, LogFileTypeCtx_::thread_data, LogFileCtx_::type, LogFileCtx_::Write, and SCEveFileType_::Write.

Referenced by OutputJSONBuffer().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SCConfLogOpenGeneric()

int SCConfLogOpenGeneric	(	SCConfNode *	conf,
		LogFileCtx *	log_ctx,
		const char *	default_filename,
		int	rotate
	)

open a generic output "log file", which may be a regular file or a socket

Parameters

conf	ConfNode structure for the output section in question
log_ctx	Log file context allocated by caller
default_filename	Default name of file to open, if not specified in ConfNode
rotate	Register the file for rotation in HUP.

Return values