logging.h File Reference

Abstract interface for event logging. More...

#include <syslog.h>
#include <stdbool.h>

Include dependency graph for logging.h:

Macros
#define	CACE_LOG_CRIT(...)   cace_log(LOG_CRIT, __FILE__, __LINE__, __func__, __VA_ARGS__)
	Perform LOG_CRIT level logging with auto-filled parameters.
#define	CACE_LOG_ERR(...)   cace_log(LOG_ERR, __FILE__, __LINE__, __func__, __VA_ARGS__)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
#define	CACE_LOG_WARNING(...)   cace_log(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
#define	CACE_LOG_INFO(...)   cace_log(LOG_INFO, __FILE__, __LINE__, __func__, __VA_ARGS__)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
#define	CACE_LOG_DEBUG(...)   cace_log(LOG_DEBUG, __FILE__, __LINE__, __func__, __VA_ARGS__)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Functions
void	cace_openlog (void)
	Opens the event log.
void	cace_closelog (void)
	Closes the event log.
int	cace_log_get_severity (int *severity, const char *name)
	Interpret a text name as a severity level.
void	cace_log_set_least_severity (int severity)
	Set the least severity enabled for logging.
bool	cace_log_is_enabled_for (int severity)
	Determine if a particular severity is being logged.
void	cace_log (int severity, const char *filename, int lineno, const char *funcname, const char *format,...)
	Log an event.

Detailed Description

Abstract interface for event logging.

Macro Definition Documentation

CACE_LOG_CRIT

#define CACE_LOG_CRIT

(

...

)

cace_log(LOG_CRIT, __FILE__, __LINE__, __func__, __VA_ARGS__)

Perform LOG_CRIT level logging with auto-filled parameters.

The arguments to this macro are passed to cace_log() as the format and its parameter values.

CACE_LOG_DEBUG

#define CACE_LOG_DEBUG

(

...

)

cace_log(LOG_DEBUG, __FILE__, __LINE__, __func__, __VA_ARGS__)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

CACE_LOG_ERR

#define CACE_LOG_ERR

(

...

)

cace_log(LOG_ERR, __FILE__, __LINE__, __func__, __VA_ARGS__)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

CACE_LOG_INFO

#define CACE_LOG_INFO

(

...

)

cace_log(LOG_INFO, __FILE__, __LINE__, __func__, __VA_ARGS__)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

CACE_LOG_WARNING

#define CACE_LOG_WARNING

(

...

)

cace_log(LOG_WARNING, __FILE__, __LINE__, __func__, __VA_ARGS__)

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Function Documentation

cace_closelog()

void cace_closelog

(

void

)

Closes the event log.

This is a mimic to POSIX closelog()

See also

cace_openlog

References cace_log_event_deinit(), cace_log_event_init(), event_queue, cace_log_event_t::message, cace_log_event_t::severity, thr_sink, thr_valid, and write_log().

Referenced by main(), and suiteTearDown().

cace_log()

void cace_log	(	int	severity,
		const char *	filename,
		int	lineno,
		const char *	funcname,
		const char *	format,
			...
	)

Log an event.

Parameters

	severity	The severity from a subset of the POSIX syslog values.
[in]	filename	The originating file name, which may include directory parts.
[in]	lineno	The originating file line number.
[in]	funcname	The originating function name.
[in]	format	The log message format string.
	...	Values for the format string.

References cace_log_event_deinit(), cace_log_event_init(), cace_log_is_enabled_for(), cace_log_event_t::context, did_crit, event_queue, cace_log_event_t::message, cace_log_event_t::severity, thr_valid, va_end(), va_start(), and write_log().

cace_log_get_severity()

int cace_log_get_severity	(	int *	severity,
		const char *	name
	)

Interpret a text name as a severity level.

Parameters

[out]	severity	The associated severity level.
[in]	name	The text name, which is case insensitive.

Returns

Zero if successful.

References CHKERR1, and sev_names.

Referenced by main(), and mgr_parse_args().

cace_log_is_enabled_for()

bool cace_log_is_enabled_for

(

int

severity

)

Determine if a particular severity is being logged.

This function is multi-thread safe.

Parameters

severity

The severity from a subset of the POSIX syslog values.

Returns

True if the severity level will be logged.

See also

cace_log_set_least_severity

References least_severity.

Referenced by agentParseHex(), cace_amm_actual_param_set_populate(), cace_amm_obj_ns_add_obj(), cace_amm_semtype_tblt_match(), cace_amm_semtype_union_convert(), cace_amp_msg_decode(), cace_amp_msg_encode(), cace_amp_proxy_cli_recv(), cace_amp_proxy_msg_recv(), cace_log(), refda_acl_search_endpoint(), refda_acl_search_permission(), refda_adm_ietf_dtnma_agent_ctrl_ensure_const(), refda_adm_ietf_dtnma_agent_ctrl_ensure_var(), refda_adm_ietf_dtnma_agent_ctrl_var_reset(), refda_adm_ietf_dtnma_agent_ctrl_var_store(), refda_binding_ident_bases(), refda_binding_semtype_use(), refda_ctrl_exec_ctx_check_result(), refda_edd_prod_check_result(), refda_eval_oper(), refda_eval_target(), refda_exec_proc_ctrl_finish(), refda_exec_proc_ctrl_start(), refda_exec_proc_expand(), refda_exec_worker_iteration(), refda_oper_eval_ctx_populate(), refda_reporting_gen(), refda_reporting_rptt_val(), refda_reporting_target(), refda_valprod_const_run(), refda_valprod_edd_run(), refda_valprod_run(), refda_valprod_var_run(), refdm_db_insert_execset(), refdm_db_insert_rptset(), refdm_ingress_worker(), and stdin_recv().

cace_log_set_least_severity()

void cace_log_set_least_severity

(

int

severity

)

Set the least severity enabled for logging.

Other events will be dropped by the logging facility. This function is multi-thread safe.

Parameters

severity

The severity from a subset of the POSIX syslog values.

See also

cace_log_is_enabled_for

References least_severity.

Referenced by LLVMFuzzerInitialize(), and main().

cace_openlog()

void cace_openlog

(

void

)

Opens the event log.

Note

This should be called once per process, not thread or library instance. At the end of the process there should be a call to cace_closelog()

This is a mimic to POSIX openlog()

References BSL_LOG_QUEUE_SIZE, cace_log_event_deinit(), cace_log_event_init(), event_queue, cace_log_event_t::message, cace_log_event_t::severity, thr_sink, thr_valid, work_sink(), and write_log().

Referenced by LLVMFuzzerInitialize(), main(), and suiteSetUp().