#include "suricata-common.h"
#include "util-debug-filters.h"

Include dependency graph for util-debug-filters.c:

Functions
int	SCLogMatchFGFilterWL (const char file, const char function, int line)
	Checks if there is a match for the incoming log_message with any of the FG filters. If there is a match, it allows the message to be logged, else it rejects that message. More...

int	SCLogMatchFGFilterBL (const char file, const char function, int line)
	Checks if there is a match for the incoming log_message with any of the FG filters. If there is a match it rejects the logging for that messages, else it allows that message to be logged. More...

int	SCLogAddFGFilterWL (const char file, const char function, int line)
	Adds a Whitelist(WL) fine-grained(FG) filter. A FG filter WL filter allows messages that match this filter, to be logged, while the filter is defined using a file_name, function_name and line_number. More...

int	SCLogAddFGFilterBL (const char file, const char function, int line)
	Adds a Blacklist(BL) fine-grained(FG) filter. A FG filter BL filter allows messages that don't match this filter, to be logged, while the filter is defined using a file_name, function_name and line_number. More...

void	SCLogReleaseFGFilters (void)

int	SCLogPrintFGFilters ()
	Prints the FG filters(both WL and BL). Used for debugging purposes. More...

int	SCLogMatchFDFilter (const char *function)
	Checks if there is a match for the incoming log_message with any of the FD filters. More...

int	SCLogCheckFDFilterEntry (const char *function)
	Updates a FD filter, based on whether the function that calls this function, is registered as a FD filter or not. This is called by a function only on its entry. More...

void	SCLogCheckFDFilterExit (const char *function)
	Updates a FD filter, based on whether the function that calls this function, is registered as a FD filter or not. This is called by a function only before its exit. More...

int	SCLogAddFDFilter (const char *function)
	Adds a Function-Dependent(FD) filter. More...

void	SCLogReleaseFDFilters (void)
	Releases all the FD filters added to the logging module. More...

int	SCLogRemoveFDFilter (const char *function)
	Removes a Function-Dependent(FD) filter. More...

int	SCLogPrintFDFilters (void)
	Prints the FG filters(both WL and BL). Used for debugging purposes. More...

void	SCLogAddToFGFFileList (SCLogFGFilterFile fgf_file, const char file, const char *function, int line, int listtype)
	Helper function used internally to add a FG filter. This function is called when the file component of the incoming filter has no entry in the filter list. More...

void	SCLogAddToFGFFuncList (SCLogFGFilterFile fgf_file, SCLogFGFilterFunc fgf_func, const char *function, int line)
	Helper function used internally to add a FG filter. This function is called when the file component of the incoming filter has an entry in the filter list, but the function component doesn't have an entry for the corresponding file component. More...

void	SCLogAddToFGFLineList (SCLogFGFilterFunc fgf_func, SCLogFGFilterLine fgf_line, int line)
	Helper function used internally to add a FG filter. This function is called when the file and function components of the incoming filter have an entry in the filter list, but the line component doesn't have an entry for the corresponding function component. More...

void	SCLogReleaseFDFilter (SCLogFDFilter *fdf)
	Releases the memory alloted to a FD filter. More...

Variables
int	sc_log_module_initialized
	Used to indicate whether the logging module has been init or not. More...

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

int	sc_log_fg_filters_present = 0

int	sc_log_fd_filters_present = 0

SCLogFGFilterFile *	sc_log_fg_filters [SC_LOG_FILTER_MAX] = { NULL, NULL }
	Holds the fine-grained filters. More...

Detailed Description

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

Debug filter utility functions

Definition in file util-debug-filters.c.

Function Documentation

◆ SCLogAddFDFilter()

int SCLogAddFDFilter ( const char * function )

Adds a Function-Dependent(FD) filter.

Parameters

Name	of the function for which a FD filter has to be registered

Return values

0	on success
-1	on failure

Definition at line 663 of file util-debug-filters.c.

References sc_log_module_initialized, and SCMutexLock.

◆ SCLogAddFGFilterBL()

int SCLogAddFGFilterBL	(	const char *	file,
		const char *	function,
		int	line
	)

Adds a Blacklist(BL) fine-grained(FG) filter. A FG filter BL filter allows messages that don't match this filter, to be logged, while the filter is defined using a file_name, function_name and line_number.

If a particular paramter in the fg-filter(file, function and line), shouldn't be considered while logging the message, one can supply NULL for the file_name or function_name and a negative line_no.

Parameters

file	File_name of the filter
function	Function_name of the filter
line	Line number of the filter

Return values

0	on successfully adding the filter
-1	on failure

Definition at line 352 of file util-debug-filters.c.

◆ SCLogAddFGFilterWL()

int SCLogAddFGFilterWL	(	const char *	file,
		const char *	function,
		int	line
	)

Adds a Whitelist(WL) fine-grained(FG) filter. A FG filter WL filter allows messages that match this filter, to be logged, while the filter is defined using a file_name, function_name and line_number.

If a particular paramter in the fg-filter(file, function and line), shouldn't be considered while logging the message, one can supply NULL for the file_name or function_name and a negative line_no.

Parameters

file	File_name of the filter
function	Function_name of the filter
line	Line number of the filter

Return values

0	on successfully adding the filter;
-1	on failure

Definition at line 331 of file util-debug-filters.c.

◆ SCLogAddToFGFFileList()

void SCLogAddToFGFFileList	(	SCLogFGFilterFile *	fgf_file,
		const char *	file,
		const char *	function,
		int	line,
		int	listtype
	)

Helper function used internally to add a FG filter. This function is called when the file component of the incoming filter has no entry in the filter list.

Parameters

fgf_file	The file component(basically the position in the list) from the filter list, after which the new filter has to be added
file	File_name of the filter
function	Function_name of the filter
line	Line number of the filter
listtype	The filter listtype. Can be either a blacklist or whitelist filter listtype(SC_LOG_FILTER_BL or SC_LOG_FILTER_WL)

Definition at line 856 of file util-debug-filters.c.

References FatalError, SCLogFGFilterFile_::file, SCLogFGFilterFunc_::func, SCLogFGFilterFile_::func, SCLogFGFilterLine_::line, SCLogFGFilterFunc_::line, SCLogFGFilterFile_::next, SC_ERR_FATAL, sc_log_fg_filters, SCMalloc, and SCStrdup.

◆ SCLogAddToFGFFuncList()

void SCLogAddToFGFFuncList	(	SCLogFGFilterFile *	fgf_file,
		SCLogFGFilterFunc *	fgf_func,
		const char *	function,
		int	line
	)

Helper function used internally to add a FG filter. This function is called when the file component of the incoming filter has an entry in the filter list, but the function component doesn't have an entry for the corresponding file component.

Parameters

fgf_file	The file component from the filter list to which the new filter has to be added
fgf_func	The function component(basically the position in the list), from the filter list, after which the new filter has to be added
function	Function_name of the filter
line	Line number of the filter

Definition at line 922 of file util-debug-filters.c.

References FatalError, SCLogFGFilterFunc_::func, SCLogFGFilterFile_::func, SCLogFGFilterLine_::line, SCLogFGFilterFunc_::line, SCLogFGFilterFunc_::next, SC_ERR_FATAL, SCMalloc, and SCStrdup.

◆ SCLogAddToFGFLineList()

void SCLogAddToFGFLineList	(	SCLogFGFilterFunc *	fgf_func,
		SCLogFGFilterLine *	fgf_line,
		int	line
	)

Helper function used internally to add a FG filter. This function is called when the file and function components of the incoming filter have an entry in the filter list, but the line component doesn't have an entry for the corresponding function component.

Parameters

fgf_func	The function component from the filter list to which the new filter has to be added
fgf_line	The function component(basically the position in the list), from the filter list, after which the new filter has to be added
line	Line number of the filter

Definition at line 972 of file util-debug-filters.c.

References FatalError, SCLogFGFilterLine_::line, SCLogFGFilterFunc_::line, SCLogFGFilterLine_::next, SC_ERR_FATAL, and SCMalloc.

◆ SCLogCheckFDFilterEntry()

int SCLogCheckFDFilterEntry ( const char * function )

Updates a FD filter, based on whether the function that calls this function, is registered as a FD filter or not. This is called by a function only on its entry.

Parameters

function Function_name from where the log_message originated

Return values

1	Since it is a hack to get things working inside the macros

Definition at line 530 of file util-debug-filters.c.

References sc_log_module_initialized, and SCMutexLock.

◆ SCLogCheckFDFilterExit()

void SCLogCheckFDFilterExit ( const char * function )

Updates a FD filter, based on whether the function that calls this function, is registered as a FD filter or not. This is called by a function only before its exit.

Parameters

function Function_name from where the log_message originated

Definition at line 604 of file util-debug-filters.c.

References sc_log_module_initialized, and SCMutexLock.

◆ SCLogMatchFDFilter()

int SCLogMatchFDFilter ( const char * function )

Checks if there is a match for the incoming log_message with any of the FD filters.

Parameters

function Function_name from where the log_message originated

Return values

1	if there is a match
0	on no match;

Definition at line 477 of file util-debug-filters.c.

References sc_log_module_initialized, and SCMutexLock.

Referenced by SCLog(), and SCLogErr().

Here is the caller graph for this function:

◆ SCLogMatchFGFilterBL()

int SCLogMatchFGFilterBL	(	const char *	file,
		const char *	function,
		int	line
	)

Checks if there is a match for the incoming log_message with any of the FG filters. If there is a match it rejects the logging for that messages, else it allows that message to be logged.

\praram file File_name from where the log_message originated

Parameters

function	Function_name from where the log_message originated
line	Line number from where the log_message originated

Return values

1	if there is a match
0	on no match
-1	on failure

Definition at line 310 of file util-debug-filters.c.

Referenced by SCLog(), and SCLogErr().

Here is the caller graph for this function:

◆ SCLogMatchFGFilterWL()

int SCLogMatchFGFilterWL	(	const char *	file,
		const char *	function,
		int	line
	)

Checks if there is a match for the incoming log_message with any of the FG filters. If there is a match, it allows the message to be logged, else it rejects that message.

Parameters

file	File_name from where the log_message originated
function	Function_name from where the log_message originated
line	Line number from where the log_message originated

Return values

1	if there is a match
0	on no match
-1	on failure

Definition at line 292 of file util-debug-filters.c.

Referenced by SCLog(), and SCLogErr().

Here is the caller graph for this function:

◆ SCLogPrintFDFilters()

int SCLogPrintFDFilters ( void )

Prints the FG filters(both WL and BL). Used for debugging purposes.

Return values

count The no of FG filters

Definition at line 812 of file util-debug-filters.c.

References sc_log_module_initialized, and SCMutexLock.

◆ SCLogPrintFGFilters()

int SCLogPrintFGFilters ( )

Prints the FG filters(both WL and BL). Used for debugging purposes.

Return values

count The no of FG filters

Definition at line 409 of file util-debug-filters.c.

References SC_LOG_FILTER_MAX, sc_log_module_initialized, and SCMutexLock.

◆ SCLogReleaseFDFilter()

void SCLogReleaseFDFilter ( SCLogFDFilter * fdf )

Releases the memory alloted to a FD filter.

Parameters

Pointer to the FD filter that has to be freed

Definition at line 1000 of file util-debug-filters.c.

References SCLogFDFilter_::func, and SCFree.

◆ SCLogReleaseFDFilters()

void SCLogReleaseFDFilters ( void )

Releases all the FD filters added to the logging module.

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

References SCMutexLock.

◆ SCLogReleaseFGFilters()

void SCLogReleaseFGFilters ( void )

Definition at line 357 of file util-debug-filters.c.

References SC_LOG_FILTER_MAX, and SCMutexLock.

◆ SCLogRemoveFDFilter()

int SCLogRemoveFDFilter ( const char * function )

Removes a Function-Dependent(FD) filter.

Parameters

Name	of the function for which a FD filter has to be unregistered

Return values

0	on success(the filter was removed or the filter was not present)
-1	on failure/error

Definition at line 752 of file util-debug-filters.c.

References sc_log_module_initialized, and SCMutexLock.

Variable Documentation

◆ sc_log_fd_filters_present

int sc_log_fd_filters_present = 0

Definition at line 37 of file util-debug-filters.c.

Referenced by SCLog(), and SCLogErr().

◆ sc_log_fg_filters

SCLogFGFilterFile* sc_log_fg_filters[SC_LOG_FILTER_MAX] = { NULL, NULL }

Holds the fine-grained filters.

Definition at line 42 of file util-debug-filters.c.

Referenced by SCLogAddToFGFFileList().

◆ sc_log_fg_filters_present

int sc_log_fg_filters_present = 0

Definition at line 34 of file util-debug-filters.c.

Referenced by SCLog(), and SCLogErr().

◆ sc_log_module_cleaned

int sc_log_module_cleaned

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

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

◆ sc_log_module_initialized

int sc_log_module_initialized

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

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

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

Functions

Variables

Detailed Description

Function Documentation

◆ SCLogAddFDFilter()

◆ SCLogAddFGFilterBL()

◆ SCLogAddFGFilterWL()

◆ SCLogAddToFGFFileList()

◆ SCLogAddToFGFFuncList()

◆ SCLogAddToFGFLineList()

◆ SCLogCheckFDFilterEntry()

◆ SCLogCheckFDFilterExit()

◆ SCLogMatchFDFilter()

◆ SCLogMatchFGFilterBL()

◆ SCLogMatchFGFilterWL()

◆ SCLogPrintFDFilters()

◆ SCLogPrintFGFilters()

◆ SCLogReleaseFDFilter()

◆ SCLogReleaseFDFilters()

◆ SCLogReleaseFGFilters()

◆ SCLogRemoveFDFilter()

Variable Documentation

◆ sc_log_fd_filters_present

◆ sc_log_fg_filters

◆ sc_log_fg_filters_present

◆ sc_log_module_cleaned

◆ sc_log_module_initialized