#include "suricata-common.h"
#include "util-debug.h"
#include "output.h"
#include "suricata.h"
#include "util-conf.h"
#include "util-enum.h"
#include "util-path.h"
#include "util-syslog.h"
#include "util-time.h"

Include dependency graph for util-debug.c:

Functions
SCError	SCLogMessage (const SCLogLevel log_level, const char file, const unsigned int line, const char function, const char module, const char message)
	Adds the global log_format to the outgoing buffer.

void	SCLog (int x, const char file, const char func, const int line, const char module, const char fmt,...)

void	SCLogErr (int x, const char file, const char func, const int line, const char module, const char fmt,...)

int	SCLogDebugEnabled (void)
	Returns whether debug messages are enabled to be logged or not.

SCLogOPBuffer *	SCLogAllocLogOPBuffer (void)
	Allocates an output buffer for an output interface. Used when we want the op_interface log_format to override the global_log_format. Currently not used.

SCLogLevel	SCLogGetLogLevel (void)

SCLogInitData *	SCLogAllocLogInitData (void)
	Returns a pointer to a new SCLogInitData. This is a public interface intended to be used after the logging parameters are read from the conf file.

void	SCLogAppendOPIfaceCtx (SCLogOPIfaceCtx iface_ctx, SCLogInitData sc_lid)
	Appends an output_interface to the output_interface list sent in head.

void	SCLogInitLogModule (SCLogInitData *sc_lid)
	Initializes the logging module.

void	SCLogLoadConfig (int daemon, int verbose, uint32_t userid, uint32_t groupid)

void	SCLogDeInitLogModule (void)
	De-Initializes the logging module.

void	SCFatalErrorOnInitStatic (const char *arg)

void	SCLogRegisterTests (void)

Variables
SCEnumCharMap	sc_log_level_map []

SCEnumCharMap	sc_log_slevel_map []

SCEnumCharMap	sc_log_op_iface_map []

SCLogLevel	sc_log_global_log_level
	Holds the global log level. Is the same as sc_log_config->log_level.

int	sc_log_module_initialized = 0
	Used to indicate whether the logging module has been init or not.

int	sc_log_module_cleaned = 0
	Used to indicate whether the logging module has been cleaned or not.

Detailed Description

Author: Anoop Saldanha anoop.nosp@m.sald.nosp@m.anha@.nosp@m.gmai.nosp@m.l.com

Debug utility functions

Definition in file util-debug.c.

Function Documentation

◆ SCFatalErrorOnInitStatic()

void SCFatalErrorOnInitStatic ( const char * arg )

Definition at line 1614 of file util-debug.c.

References FatalErrorOnInit.

◆ SCLog()

void SCLog	(	int	x,
		const char *	file,
		const char *	func,
		const int	line,
		const char *	module,
		const char *	fmt,
			...
	)

Definition at line 723 of file util-debug.c.

References sc_log_fd_filters_present, sc_log_fg_filters_present, sc_log_global_log_level, SC_LOG_MAX_LOG_MSG_LEN, SCLogMatchFDFilter(), SCLogMatchFGFilterBL(), SCLogMatchFGFilterWL(), and SCLogMessage().

Here is the call graph for this function:

◆ SCLogAllocLogInitData()

SCLogInitData * SCLogAllocLogInitData ( void )

Returns a pointer to a new SCLogInitData. This is a public interface intended to be used after the logging parameters are read from the conf file.

Return values

sc_lid Pointer to the newly created SCLogInitData \initonly

Definition at line 1250 of file util-debug.c.

References SCCalloc.

Referenced by SCLogLoadConfig().

Here is the caller graph for this function:

◆ SCLogAllocLogOPBuffer()

SCLogOPBuffer * SCLogAllocLogOPBuffer ( void )

Allocates an output buffer for an output interface. Used when we want the op_interface log_format to override the global_log_format. Currently not used.

Return values

buffer Pointer to the newly created output_buffer

Definition at line 786 of file util-debug.c.

References FatalError, SCLogOPBuffer_::log_format, SCLogOPIfaceCtx_::log_format, SCLogOPBuffer_::msg, SCLogOPIfaceCtx_::next, SCLogConfig_::op_ifaces, SCLogConfig_::op_ifaces_cnt, SCMalloc, and SCLogOPBuffer_::temp.

◆ SCLogAppendOPIfaceCtx()

void SCLogAppendOPIfaceCtx	(	SCLogOPIfaceCtx *	iface_ctx,
		SCLogInitData *	sc_lid
	)

Appends an output_interface to the output_interface list sent in head.

Parameters

iface_ctx	Pointer to the output_interface that has to be added to head
head	Pointer to the output_interface list

Definition at line 1306 of file util-debug.c.

References head, SCLogOPIfaceCtx_::next, SCLogInitData_::op_ifaces, and SCLogInitData_::op_ifaces_cnt.

Referenced by SCLogLoadConfig().

Here is the caller graph for this function:

◆ SCLogDebugEnabled()

int SCLogDebugEnabled ( void )

Returns whether debug messages are enabled to be logged or not.

Return values

1	if debug messages are enabled to be logged
0	if debug messages are not enabled to be logged

Definition at line 767 of file util-debug.c.

References SC_LOG_DEBUG, and sc_log_global_log_level.

Referenced by AppLayerProtoDetectPrepareState(), DecodeIPV4(), DecodeIPV6(), DecodeNSH(), DetectBytejumpDoMatch(), DetectPortInsert(), FlowVarPrint(), SigPrepareStage1(), SRepLoadFileFromFD(), and StreamTcpReassembleInsertSegment().

Here is the caller graph for this function:

◆ SCLogDeInitLogModule()

void SCLogDeInitLogModule ( void )

De-Initializes the logging module.

Definition at line 1594 of file util-debug.c.

References sc_log_global_log_level, sc_log_module_cleaned, sc_log_module_initialized, SCLogReleaseFDFilters(), SCLogReleaseFGFilters(), and SCMutexDestroy.

Referenced by GlobalsDestroy(), and SCLogInitLogModule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SCLogErr()

void SCLogErr	(	int	x,
		const char *	file,
		const char *	func,
		const int	line,
		const char *	module,
		const char *	fmt,
			...
	)

Definition at line 742 of file util-debug.c.

References sc_log_fd_filters_present, sc_log_fg_filters_present, sc_log_global_log_level, SC_LOG_MAX_LOG_MSG_LEN, SCLogMatchFDFilter(), SCLogMatchFGFilterBL(), SCLogMatchFGFilterWL(), and SCLogMessage().

Here is the call graph for this function:

◆ SCLogGetLogLevel()

SCLogLevel SCLogGetLogLevel ( void )

Definition at line 1070 of file util-debug.c.

References sc_log_global_log_level.

◆ SCLogInitLogModule()

void SCLogInitLogModule ( SCLogInitData * sc_lid )

Initializes the logging module.

Parameters

sc_lid The initialization data for the logging module. If sc_lid is NULL, we would stick to the default configuration for the logging subsystem. \initonly

Definition at line 1390 of file util-debug.c.

References FatalError, sc_log_global_log_level, sc_log_module_cleaned, sc_log_module_initialized, SCCalloc, SCLogDeInitLogModule(), and SCMutexInit.

Referenced by InitGlobal(), and SCLogLoadConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SCLogLoadConfig()

void SCLogLoadConfig	(	int	daemon,
		int	verbose,
		uint32_t	userid,
		uint32_t	groupid
	)

Definition at line 1420 of file util-debug.c.

References FatalError, SCLogInitData_::global_log_format, SCLogInitData_::global_log_level, SCLogConfig_::log_format, MAX, SCConfNode_::name, next, SCLogInitData_::op_filter, SCLogConfig_::op_filter, PathIsAbsolute(), SC_LOG_DEF_FILE_FORMAT, SC_LOG_DEF_SYSLOG_FACILITY, SC_LOG_DEF_SYSLOG_FACILITY_STR, sc_log_global_log_level, sc_log_level_map, SC_LOG_NOTICE, SC_LOG_OP_TYPE_JSON, SC_LOG_OP_TYPE_REGULAR, SCConfGet(), SCConfGetNode(), SCConfNodeLookupChild(), SCConfNodeLookupChildValue(), SCConfValIsFalse(), SCFree, SCLogAllocLogInitData(), SCLogAppendOPIfaceCtx(), SCLogDebug, SCLogError, SCLogInitLogModule(), SCLogWarning, SCMapEnumNameToValue(), SCStrdup, SCSyslogGetFacilityMap(), TAILQ_FOREACH, type, and SCConfNode_::val.

Referenced by ListAppLayerHooks(), ListAppLayerProtocols(), ListKeywords(), and SuricataInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SCLogMessage()

SCError SCLogMessage	(	const SCLogLevel	log_level,
		const char *	file,
		const unsigned int	line,
		const char *	function,
		const char *	module,
		const char *	message
	)

Adds the global log_format to the outgoing buffer.

Parameters

log_level	log_level of the message that has to be logged
msg	Buffer containing the outgoing message
file	File_name from where the message originated
function	Function_name from where the message originated
line	Line_no from where the messaged originated

Return values

SC_OK on success; else an error code

Definition at line 652 of file util-debug.c.

References SCLogOPIfaceCtx_::file, SCLogOPIfaceCtx_::file_d, SCLogOPIfaceCtx_::fp_mutex, SCLogOPIfaceCtx_::iface, SCLogOPIfaceCtx_::log_format, SCLogConfig_::log_format, SCLogOPIfaceCtx_::log_level, SCLogOPIfaceCtx_::next, SCLogConfig_::op_ifaces, SCLogOPIfaceCtx_::rotation_flag, SC_LOG_ERROR, SC_LOG_MAX_LOG_MSG_LEN, sc_log_module_initialized, SC_LOG_NOTSET, SC_LOG_OP_IFACE_CONSOLE, SC_LOG_OP_IFACE_FILE, SC_LOG_OP_IFACE_SYSLOG, SC_OK, SCLogError, SCMutexLock, SCMutexUnlock, SCTIME_FROM_TIMEVAL, ts, SCLogOPIfaceCtx_::type, and SCLogOPIfaceCtx_::use_color.

Referenced by SCLog(), and SCLogErr().

Here is the caller graph for this function:

◆ SCLogRegisterTests()

void SCLogRegisterTests ( void )

Definition at line 1801 of file util-debug.c.

References UtRegisterTest().

Here is the call graph for this function:

Variable Documentation

◆ sc_log_global_log_level

SCLogLevel sc_log_global_log_level

Holds the global log level. Is the same as sc_log_config->log_level.

Definition at line 101 of file util-debug.c.

Referenced by LogFileEnsureExists(), SCLog(), SCLogDebugEnabled(), SCLogDeInitLogModule(), SCLogErr(), SCLogGetLogLevel(), SCLogInitLogModule(), and SCLogLoadConfig().

◆ sc_log_level_map

SCEnumCharMap sc_log_level_map[]

Initial value:

= {
    { "Not set",        SC_LOG_NOTSET },
    { "None",           SC_LOG_NONE },
    { "Error",          SC_LOG_ERROR },
    { "Warning",        SC_LOG_WARNING },
    { "Notice",         SC_LOG_NOTICE },
    { "Info",           SC_LOG_INFO },
    { "Perf",           SC_LOG_PERF },
    { "Config",         SC_LOG_CONFIG },
    { "Debug",          SC_LOG_DEBUG },
    { NULL,             -1 }
}

Definition at line 41 of file util-debug.c.

Referenced by SCLogLoadConfig().

◆ sc_log_module_cleaned

int sc_log_module_cleaned = 0

Used to indicate whether the logging module has been cleaned or not.

Definition at line 111 of file util-debug.c.

Referenced by SCLogDeInitLogModule(), and SCLogInitLogModule().

◆ sc_log_module_initialized

int sc_log_module_initialized = 0

Used to indicate whether the logging module has been init or not.

Definition at line 106 of file util-debug.c.

Referenced by SCLogAddFDFilter(), SCLogCheckFDFilterEntry(), SCLogCheckFDFilterExit(), SCLogDeInitLogModule(), SCLogInitLogModule(), SCLogMatchFDFilter(), SCLogMessage(), SCLogPrintFDFilters(), SCLogPrintFGFilters(), and SCLogRemoveFDFilter().

◆ sc_log_op_iface_map

SCEnumCharMap sc_log_op_iface_map[]

Initial value:

= {
    { "Console",        SC_LOG_OP_IFACE_CONSOLE },
    { "File",           SC_LOG_OP_IFACE_FILE },
    { "Syslog",         SC_LOG_OP_IFACE_SYSLOG },
    { NULL,             -1 }
}

Definition at line 68 of file util-debug.c.

◆ sc_log_slevel_map

SCEnumCharMap sc_log_slevel_map[]

Initial value:

= {
    { "Not set",        SC_LOG_NOTSET },
    { "None",           SC_LOG_NONE },
    { "E",              SC_LOG_ERROR },
    { "W",              SC_LOG_WARNING },
    { "i",              SC_LOG_NOTICE },
    { "i",              SC_LOG_INFO },
    { "i",              SC_LOG_PERF },
    { "i",              SC_LOG_CONFIG },
    { "d",              SC_LOG_DEBUG },
    { NULL,             -1 }
}

Definition at line 54 of file util-debug.c.

Functions

Variables

Detailed Description

Function Documentation

◆ SCFatalErrorOnInitStatic()

◆ SCLog()

◆ SCLogAllocLogInitData()

◆ SCLogAllocLogOPBuffer()

◆ SCLogAppendOPIfaceCtx()

◆ SCLogDebugEnabled()

◆ SCLogDeInitLogModule()

◆ SCLogErr()

◆ SCLogGetLogLevel()

◆ SCLogInitLogModule()

◆ SCLogLoadConfig()

◆ SCLogMessage()

◆ SCLogRegisterTests()

Variable Documentation

◆ sc_log_global_log_level

◆ sc_log_level_map

◆ sc_log_module_cleaned

◆ sc_log_module_initialized

◆ sc_log_op_iface_map

◆ sc_log_slevel_map