log.h File Reference

Macros and function definitions to write log messages, and control the logging system. More...

#include <freeradius-devel/server/request.h>
#include <freeradius-devel/util/log.h>
#include <freeradius-devel/util/event.h>
#include <freeradius-devel/util/packet.h>

Include dependency graph for log.h:

Go to the source code of this file.

Data Structures
struct	fr_rate_limit_t
	Track when a log message was last repeated. More...
struct	log_dst
struct	log_fd_event_ctx_t
	Context structure for the log fd event function. More...
struct	rindent_s

Macros
#define	_FR_LOG_DST(_lvl, _fmt, ...)   fr_log(LOG_DST, _lvl, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)
#define	_FR_LOG_DST_FATAL(_fmt, ...)   log_fatal(LOG_DST, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)
#define	_FR_LOG_DST_MARKER(_lvl, _str, _str_len, _marker_idx, _line_prefix_fmt, ...)    fr_log_marker(LOG_DST, _lvl, __FILE__, __LINE__, _str, _str_len, _marker_idx, _line_prefix_fmt, ## __VA_ARGS__)
	Write a log message with marker.
#define	_FR_LOG_DST_PERROR(_lvl, _fmt, ...)   fr_log_perror(LOG_DST, _lvl, __FILE__, __LINE__, NULL, _fmt, ## __VA_ARGS__)
#define	_FR_LOG_PREFIX(_lvl, _fmt, ...)   _FR_LOG_DST(_lvl, _fmt, ## __VA_ARGS__)
#define	_FR_LOG_PREFIX_FATAL(_fmt, ...)   _FR_LOG_DST_FATAL(_fmt, ## __VA_ARGS__)
#define	_FR_LOG_PREFIX_MARKER(_lvl, _str, _str_len, _marker_idx, _marker)   _FR_LOG_DST_MARKER(_lvl, _str, _str_len, _marker_idx, _marker, "")
#define	_FR_LOG_PREFIX_PERROR(_lvl, _fmt, ...)   _FR_LOG_DST_PERROR(_lvl, _fmt, ## __VA_ARGS__)
#define	_HEX_MARKER(_lvl, _data, _len, _slen, _error, _fmt, ...)
	Pretty print binary data as hex, with output as a wrapped block with addresses and a marker.
#define	_HEXDUMP(_lvl, _data, _len, _fmt, ...)
	Pretty print binary data as hex, with output as a wrapped block with addresses.
#define	_RHEXDUMP(_lvl, _data, _len, _fmt, ...)
	Pretty print binary data as hex, with output as a wrapped block with addresses.
#define	_RHEXDUMP_INLINE(_lvl, _data, _len, _fmt, ...)
	Pretty print binary data, with hex output inline with message.
#define	debug_enabled(_type, _lvl)   (((_type & L_DBG) != 0) && (_lvl <= fr_debug_lvl))
#define	HEX_MARKER1(_data, _len, _slen, _error, _fmt, ...)   _HEX_MARKER(L_DBG_LVL_1, _data, _len, _slen, _error, _fmt, ## __VA_ARGS__)
#define	HEX_MARKER2(_data, _len, _slen, _error, _fmt, ...)   _HEX_MARKER(L_DBG_LVL_2, _data, _len, _slen, _error, _fmt, ## __VA_ARGS__)
#define	HEX_MARKER3(_data, _len, _slen, _error, _fmt, ...)   _HEX_MARKER(L_DBG_LVL_3, _data, _len, _slen, _error, _fmt, ## __VA_ARGS__)
#define	HEX_MARKER4(_data, _len, _slen, _error, _fmt, ...)   _HEX_MARKER(L_DBG_LVL_4, _data, _len, _slen, _error, _fmt, ## __VA_ARGS__)
#define	HEXDUMP1(_data, _len, _fmt, ...)   _HEXDUMP(L_DBG_LVL_1, _data, _len, _fmt, ## __VA_ARGS__)
#define	HEXDUMP2(_data, _len, _fmt, ...)   _HEXDUMP(L_DBG_LVL_2, _data, _len, _fmt, ## __VA_ARGS__)
#define	HEXDUMP3(_data, _len, _fmt, ...)   _HEXDUMP(L_DBG_LVL_3, _data, _len, _fmt, ## __VA_ARGS__)
#define	HEXDUMP4(_data, _len, _fmt, ...)   _HEXDUMP(L_DBG_LVL_4, _data, _len, _fmt, ## __VA_ARGS__)
#define	LOG_DST   &default_log
#define	log_dst_foreach(_head, _iter)    for (log_dst_t *JOIN(_next,_iter), *_iter = _head; JOIN(_next,_iter) = (_head)->next, _iter != NULL; _iter = JOIN(_next,_iter))
	Iterate over the contents of a log_dst_t.
#define	LOG_PACKET_DEBUG(_request, ...)   if (RDEBUG_ENABLED) log_request_packet(_request, ## __VA_ARGS__)
#define	RATE_LIMIT_GLOBAL(_log, _fmt, ...)
	Rate limit messages using a global limiting entry.
#define	RATE_LIMIT_GLOBAL_ROPTIONAL(_l_request, _l_global, _fmt, ...)
	Rate limit messages using a global limiting entry.
#define	RATE_LIMIT_LOCAL(_entry, _log, _fmt, ...)
	Rate limit messages using a local limiting entry.
#define	RATE_LIMIT_LOCAL_ROPTIONAL(_entry, _l_request, _l_global, _fmt, ...)
	Rate limit messages using a local limiting entry.
#define	RDMARKER(_str, _marker_idx, _marker, ...)   RMARKER(L_DBG, L_DBG_LVL_1, _str, _marker_idx, _marker, ## __VA_ARGS__)
	Output string with error marker, showing where format error occurred.
#define	REMARKER(_str, _marker_idx, _marker, ...)   RMARKER(L_DBG_ERR, L_DBG_LVL_1, _str, _marker_idx, _marker, ## __VA_ARGS__)
	Output string with error marker, showing where format error occurred.
#define	REXDENT()
	Exdent (unindent) R* messages by one level.
#define	RHEXDUMP1(_data, _len, _fmt, ...)   _RHEXDUMP(L_DBG_LVL_1, _data, _len, _fmt, ## __VA_ARGS__)
#define	RHEXDUMP2(_data, _len, _fmt, ...)   _RHEXDUMP(L_DBG_LVL_2, _data, _len, _fmt, ## __VA_ARGS__)
#define	RHEXDUMP3(_data, _len, _fmt, ...)   _RHEXDUMP(L_DBG_LVL_3, _data, _len, _fmt, ## __VA_ARGS__)
#define	RHEXDUMP4(_data, _len, _fmt, ...)   _RHEXDUMP(L_DBG_LVL_4, _data, _len, _fmt, ## __VA_ARGS__)
#define	RHEXDUMP_INLINE1(_data, _len, _fmt, ...)   _RHEXDUMP_INLINE(L_DBG_LVL_1, _data, _len, _fmt, ## __VA_ARGS__)
#define	RHEXDUMP_INLINE2(_data, _len, _fmt, ...)   _RHEXDUMP_INLINE(L_DBG_LVL_2, _data, _len, _fmt, ## __VA_ARGS__)
#define	RHEXDUMP_INLINE3(_data, _len, _fmt, ...)   _RHEXDUMP_INLINE(L_DBG_LVL_3, _data, _len, _fmt, ## __VA_ARGS__)
#define	RHEXDUMP_INLINE4(_data, _len, _fmt, ...)   _RHEXDUMP_INLINE(L_DBG_LVL_4, _data, _len, _fmt, ## __VA_ARGS__)
#define	RINDENT()
	Indent R* messages by one level.
#define	RINDENT_RESTORE(_request, _x)
#define	RINDENT_SAVE(_x, _request)
	Save indentation for later restoral.
#define	RMARKER(_type, _lvl, _str, _marker_idx, _marker, ...)
	Output string with error marker, showing where format error occurred.
#define	ROPTIONAL(_l_request, _l_global, _fmt, ...)
	Use different logging functions depending on whether request is NULL or not.
#define	ROPTIONAL_ENABLED(_e_request, _e_global)   ((request && _e_request) || _e_global)
	Check if a debug level is set by the request (if !NULL) or by the global log.

Typedefs
typedef struct cf_section	CONF_SECTION
typedef struct log_dst	log_dst_t
	A logging destination, consisting of a function and its context.
typedef void(*	log_func_t) (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *fmt, va_list ap, void *uctx)
	Logging callback to write log messages to a destination.
typedef void(*	log_request_func_t) (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *fmt,...)
	Function signature for log_request functions.
typedef struct rindent_s	rindent_t

Functions
fr_log_t *	log_dst_by_name (char const *name)
	Get a logging destination by name.
void	log_fatal (fr_log_t const *log, char const *file, int line, char const *fmt,...))
	Log a fatal error, then exit.
void	log_global_free (void)
int	log_global_init (fr_log_t *log, bool daemonize)
	Initialises the server logging functionality, and the underlying libfreeradius log.
int	log_parse_section (CONF_SECTION *cs)
	Parse a named logging section.
bool	log_rdebug_enabled (fr_log_lvl_t lvl, request_t const *request)
	Whether a request specific debug message should be logged.
void	log_request (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *fmt,...))
	Marshal variadic log arguments into a va_list and pass to normal logging functions.
void	log_request_error (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *fmt,...))
	Marshal variadic log arguments into a va_list and pass to error logging functions.
void	log_request_fd_event (UNUSED fr_event_list_t *el, int fd, UNUSED int flags, void *uctx)
	Function to provide as the readable callback to the event loop.
void	log_request_hex (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, uint8_t const *data, size_t data_len)
void	log_request_marker (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *str, size_t str_len, ssize_t marker_idx, char const *marker,...))
	Write the string being parsed, and a marker showing where the parse error occurred.
void	log_request_packet (request_t *request, fr_packet_t *packet, fr_pair_list_t *list, fr_dict_attr_t const *type_da, bool received, bool id)
	Print a packet which we received or sent.
void	log_request_pair (fr_log_lvl_t lvl, request_t *request, fr_pair_t const *parent, fr_pair_t const *vp, char const *prefix))
	Print a fr_pair_t.
void	log_request_pair_list (fr_log_lvl_t lvl, request_t *request, fr_pair_t const *parent, fr_pair_list_t const *vps, char const *prefix))
	Print a fr_pair_list_t.
void	log_request_perror (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *fmt,...))
	Drain any outstanding messages from the fr_strerror buffers.
void	log_request_proto_pair_list (fr_log_lvl_t lvl, request_t *request, fr_pair_t const *parent, fr_pair_list_t const *vp, char const *prefix))
	Print a list of protocol fr_pair_ts.
void	vlog_request (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *fmt, va_list ap, void *uctx))
	Send a log message to its destination, possibly including fields from the request.

Variables
fr_table_num_sorted_t const	log_destination_table []
size_t	log_destination_table_len
fr_table_num_sorted_t const	syslog_facility_table []
	Syslog facility table.
size_t	syslog_facility_table_len
fr_table_num_sorted_t const	syslog_severity_table []
	Syslog severity table.
size_t	syslog_severity_table_len

Log global messages
Write to the global log. Messages will always be written irrespective of the debugging level set with -x or -X. Warning If a request_t * is NOT available, these macros MUST be used. Note These macros should only be used for important global events. Debug categories Name Syslog severity Colour/style When to use INFO LOG_INFO Bold TBD WARN LOG_WARNING Yellow Warnings. Impending resource exhaustion, resource exhaustion ERROR LOG_ERR Red Critical server errors. Malformed queries, failed operations, connection errors, packet processing errors
#define	EMARKER(_str, _marker_idx, _marker)   _FR_LOG_PREFIX_MARKER(L_ERR, _str, SIZE_MAX, _marker_idx, _marker)
#define	ERROR(_fmt, ...)   _FR_LOG_PREFIX(L_ERR, _fmt, ## __VA_ARGS__)
#define	FATAL(_fmt, ...)   _FR_LOG_PREFIX_FATAL(_fmt, ## __VA_ARGS__)
#define	IMARKER(_str, _marker_idx, _marker)   _FR_LOG_PREFIX_MARKER(L_INFO, _str, SIZE_MAX, _marker_idx, _marker)
#define	INFO(_fmt, ...)   _FR_LOG_PREFIX(L_INFO, _fmt, ## __VA_ARGS__)
#define	PERROR(_fmt, ...)   _FR_LOG_PREFIX_PERROR(L_ERR, _fmt, ## __VA_ARGS__)
#define	PINFO(_fmt, ...)   _FR_LOG_PREFIX_PERROR(L_INFO, _fmt, ## __VA_ARGS__)
#define	PWARN(_fmt, ...)   _FR_LOG_PREFIX_PERROR(L_WARN, _fmt, ## __VA_ARGS__)
#define	WARN(_fmt, ...)   _FR_LOG_PREFIX(L_WARN, _fmt, ## __VA_ARGS__)
#define	WMARKER(_str, _marker_idx, _marker)   _FR_LOG_PREFIX_MARKER(L_WARN, _str, SIZE_MAX, _marker_idx, _marker)

Log global debug messages (DEBUG*)
Write debugging messages to the global log. Messages will be written if the debug level is high enough. Debug categories Name Syslog severity Colour/style When to use DEBUG LOG_DEBUG Regular Normal debug output Debug levels Level Debug arguments Macro(s) enabled When to use 1 -x DEBUG Never - Deprecated 2 -xx or -X DEBUG, DEBUG2 Interactions with external entities. Connection management, control socket, triggers, etc... 3 -xxx or -Xx DEBUG, DEBUG[2-3] Lower priority events. Polling for detail files, cleanups, etc... 4 -xxxx or -Xxx DEBUG, DEBUG[2-4] Internal server state debugging. 5 -xxxxx or -Xxxx DEBUG, DEBUG[2-5] Low level internal server state debugging.
#define	_DEBUG_LOG(_type, _lvl, _fmt, ...)   if (fr_debug_lvl >= _lvl) _FR_LOG_PREFIX(_type, _fmt, ## __VA_ARGS__)
#define	_PDEBUG_LOG(_type, _lvl, _fmt, ...)   if (fr_debug_lvl >= _lvl) _FR_LOG_PREFIX_PERROR(_type, _fmt, ## __VA_ARGS__)
#define	DEBUG(_fmt, ...)   _DEBUG_LOG(L_DBG, L_DBG_LVL_1, _fmt, ## __VA_ARGS__)
#define	DEBUG2(_fmt, ...)   _DEBUG_LOG(L_DBG, L_DBG_LVL_2, _fmt, ## __VA_ARGS__)
#define	DEBUG3(_fmt, ...)   _DEBUG_LOG(L_DBG, L_DBG_LVL_3, _fmt, ## __VA_ARGS__)
#define	DEBUG4(_fmt, ...)   _DEBUG_LOG(L_DBG, L_DBG_LVL_MAX, _fmt, ## __VA_ARGS__)
#define	DEBUG_ENABLED   debug_enabled(L_DBG, L_DBG_LVL_1)
	True if global debug level 1 messages are enabled.
#define	DEBUG_ENABLED2   debug_enabled(L_DBG, L_DBG_LVL_2)
	True if global debug level 1-2 messages are enabled.
#define	DEBUG_ENABLED3   debug_enabled(L_DBG, L_DBG_LVL_3)
	True if global debug level 1-3 messages are enabled.
#define	DEBUG_ENABLED4   debug_enabled(L_DBG, L_DBG_LVL_4)
	True if global debug level 1-4 messages are enabled.
#define	DEBUG_ENABLED5   debug_enabled(L_DBG, L_DBG_LVL_MAX)
	True if global debug level 1-5 messages are enabled.
#define	DEBUGX(_lvl, _fmt, ...)   _DEBUG_LOG(L_DBG, _lvl, _fmt, ## __VA_ARGS__)
#define	EDEBUG(_fmt, ...)   _DEBUG_LOG(L_DBG_ERR, L_DBG_LVL_1, _fmt, ## __VA_ARGS__)
#define	EDEBUG2(_fmt, ...)   _DEBUG_LOG(L_DBG_ERR, L_DBG_LVL_2, _fmt, ## __VA_ARGS__)
#define	EDEBUG3(_fmt, ...)   _DEBUG_LOG(L_DBG_ERR, L_DBG_LVL_3, _fmt, ## __VA_ARGS__)
#define	EDEBUG4(_fmt, ...)   _DEBUG_LOG(L_DBG_ERR, L_DBG_LVL_MAX, _fmt, ## __VA_ARGS__)
#define	EDEBUGX(_lvl, _fmt, ...)   _DEBUG_LOG(L_DBG_ERR, _lvl, _fmt, ## __VA_ARGS__)
#define	PDEBUG(_fmt, ...)   _PDEBUG_LOG(L_DBG, L_DBG_LVL_1, _fmt, ## __VA_ARGS__)
#define	PDEBUG2(_fmt, ...)   _PDEBUG_LOG(L_DBG, L_DBG_LVL_2, _fmt, ## __VA_ARGS__)
#define	PDEBUG3(_fmt, ...)   _PDEBUG_LOG(L_DBG, L_DBG_LVL_3, _fmt, ## __VA_ARGS__)
#define	PDEBUG4(_fmt, ...)   _PDEBUG_LOG(L_DBG, L_DBG_LVL_MAX, _fmt, ## __VA_ARGS__)
#define	PDEBUGX(_lvl, _fmt, ...)   _PDEBUG_LOG(L_DBG, _lvl, _fmt, ## __VA_ARGS__)
#define	WDEBUG(_fmt, ...)   _DEBUG_LOG(L_DBG_WARN, L_DBG_LVL_1, _fmt, ## __VA_ARGS__)
#define	WDEBUG2(_fmt, ...)   _DEBUG_LOG(L_DBG_WARN, L_DBG_LVL_2, _fmt, ## __VA_ARGS__)
#define	WDEBUG3(_fmt, ...)   _DEBUG_LOG(L_DBG_WARN, L_DBG_LVL_3, _fmt, ## __VA_ARGS__)
#define	WDEBUG4(_fmt, ...)   _DEBUG_LOG(L_DBG_WARN, L_DBG_LVL_MAX, _fmt, ## __VA_ARGS__)
#define	WDEBUGX(_lvl, _fmt, ...)   _DEBUG_LOG(L_DBG_WARN, _lvl, _fmt, ## __VA_ARGS__)

Log request-specific messages (R*)
Write to the request log, or the global log if a request logging function is not set. Messages will always be written irrespective of the debugging level set with -x or -X. Note Automatically prepends date (at lvl >= 3), request number, and module, to the log message. If a request_t * is available, these macros should be used. These macros should only be used for important global events. Debug categories Name Syslog severity Colour/style When to use RINFO LOG_INFO Bold TBD RWARN LOG_WARNING Yellow/Bold Warnings. Impending resource exhaustion, or resource exhaustion. RERROR LOG_ERR Red/Bold Critical server errors. Malformed queries, failed operations, connection errors, packet processing errors.
#define	RERROR(fmt, ...)   log_request_error(L_DBG_ERR, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RINFO(fmt, ...)   log_request(L_INFO, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RPERROR(fmt, ...)   log_request_perror(L_DBG_ERR, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RPINFO(fmt, ...)   log_request_perror(L_DBG_INFO, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RPWARN(fmt, ...)   log_request_perror(L_DBG_WARN, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RWARN(fmt, ...)   log_request(L_DBG_WARN, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Log request-specific debug (R*DEBUG*)
Write debug messages to the request log. Messages will only be written if a request log function is set and the request or global debug level is high enough. Note Automatically prepends date (at lvl >= 3), request number, and module, to the log message. Debug categories Name Syslog severity Colour and style When to use RDEBUG* LOG_DEBUG Regular Normal debugging messages RIDEBUG* LOG_DEBUG Bold Informational messages. RWDEBUG* LOG_DEBUG Yellow/Bold Warnings. Invalid configuration, missing or invalid attributes etc... REDEBUG* LOG_DEBUG Red/Bold Errors. Reject messages, bad values etc... Debug levels Level Debug arguments Macro(s) enabled When to use 1 -x R*DEBUG Packet processing, entering/exiting virtual servers, results of module calls 2 -xx or -X R*DEBUG, R*DEBUG2 Unlang keyword evaluation. Module debug output, results of queries, or execs, etc... 3 -xxx or -Xx R*DEBUG, R*DEBUG[2-3] Internal server state or packet input. State machine changes, extra attribute info, etc... 4 -xxxx or -Xxx R*DEBUG, R*DEBUG[2-4] Verbose internal server state messages or packet input. Hex dumps, structure dumps, pointer values. 5 -xxxxx or -Xxxx R*DEBUG, R*DEBUG[2-5] Low level internal server state messages.
#define	RDEBUG(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RDEBUG2(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RDEBUG3(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RDEBUG4(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RDEBUG_ENABLED   log_rdebug_enabled(L_DBG_LVL_1, request)
	True if request debug level 1 messages are enabled.
#define	RDEBUG_ENABLED2   log_rdebug_enabled(L_DBG_LVL_2, request)
	True if request debug level 1-2 messages are enabled.
#define	RDEBUG_ENABLED3   log_rdebug_enabled(L_DBG_LVL_3, request)
	True if request debug level 1-3 messages are enabled.
#define	RDEBUG_ENABLED4   log_rdebug_enabled(L_DBG_LVL_4, request)
	True if request debug level 1-4 messages are enabled.
#define	RDEBUG_ENABLED5   log_rdebug_enabled(L_DBG_LVL_MAX, request)
	True if request debug level 1-5 messages are enabled.
#define	RDEBUG_ENABLEDX(_x)   log_rdebug_enabled(_x, request)
	True if specified lvl is enabled.
#define	RDEBUGX(_l, fmt, ...)   do { if (request->log.lvl) log_request(L_DBG, _l, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	REDEBUG(fmt, ...)   log_request_error(L_DBG_ERR, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	REDEBUG2(fmt, ...)   log_request_error(L_DBG_ERR, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	REDEBUG3(fmt, ...)   log_request_error(L_DBG_ERR, L_DBG_LVL_3,request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	REDEBUG4(fmt, ...)   log_request_error(L_DBG_ERR, L_DBG_LVL_MAX, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RIDEBUG(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG_INFO, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RIDEBUG2(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG_INFO, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RIDEBUG3(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG_INFO, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RIDEBUG4(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG_INFO, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPDEBUG(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPDEBUG2(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPDEBUG3(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPDEBUG4(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPEDEBUG(fmt, ...)   log_request_perror(L_DBG_ERR, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RPEDEBUG2(fmt, ...)   log_request_perror(L_DBG_ERR, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RPEDEBUG3(fmt, ...)   log_request_perror(L_DBG_ERR, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RPEDEBUG4(fmt, ...)   log_request_perror(L_DBG_ERR, L_DBG_LVL_MAX, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)
#define	RPIDEBUG(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG_INFO, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPIDEBUG2(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG_INFO, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPIDEBUG3(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG_INFO, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPIDEBUG4(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG_INFO, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPWDEBUG(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG_WARN, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPWDEBUG2(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG_WARN, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPWDEBUG3(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG_WARN, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RPWDEBUG4(fmt, ...)   do { if (request->log.lvl) log_request_perror(L_DBG_WARN, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RWDEBUG(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG_WARN, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RWDEBUG2(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG_WARN, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RWDEBUG3(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG_WARN, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)
#define	RWDEBUG4(fmt, ...)   do { if (request->log.lvl) log_request(L_DBG_WARN, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Detailed Description

Macros and function definitions to write log messages, and control the logging system.

Id

4084767177fa3d8a60686b6cdd93044bef0ce69c

Copyright

2015 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

2013 Alan DeKok (aland.nosp@m.@fre.nosp@m.eradi.nosp@m.us.o.nosp@m.rg)

Definition in file log.h.

---

Data Structure Documentation

fr_rate_limit_t

struct fr_rate_limit_t

Track when a log message was last repeated.

Definition at line 564 of file log.h.

Collaboration diagram for fr_rate_limit_t:

Data Fields
fr_time_t	last_complained	Last time we emitted a log message.
fr_time_t	now	Current time - Here because it avoids repeated stack allocation.
unsigned int	repeated	Number of "skipped" messages.

log_dst

struct log_dst

Definition at line 70 of file log.h.

Collaboration diagram for log_dst:

Data Fields
log_func_t	func	Function to call to log to this destination.
fr_log_lvl_t	lvl	Log messages with lvl >= to this should be logged.
log_dst_t *	next	Next logging destination.
void *	uctx	Context to pass to the logging function.

log_fd_event_ctx_t

struct log_fd_event_ctx_t

Context structure for the log fd event function.

This enables a file descriptor to be inserted into an event loop and produce log output. It's useful for execd child processes and for capturing stdout/stderr from libraries.

Definition at line 83 of file log.h.

Collaboration diagram for log_fd_event_ctx_t:

Data Fields
fr_log_lvl_t	lvl	Priority of the message.
char const *	prefix	To add to log messages.
request_t *	request	request to log messages in the context of.
fr_log_type_t	type	What type of log message it is.

rindent_s

struct rindent_s

Definition at line 40 of file log.h.

Data Fields
uint8_t	unlang	By how much to indent log messages. uin8_t so it's obvious when a request has been exdented too much.

Macro Definition Documentation

_DEBUG_LOG

#define _DEBUG_LOG	(		_type,
			_lvl,
			_fmt,
			...
	)		if (fr_debug_lvl >= _lvl) _FR_LOG_PREFIX(_type, _fmt, ## __VA_ARGS__)

Definition at line 268 of file log.h.

_FR_LOG_DST

#define _FR_LOG_DST	(		_lvl,
			_fmt,
			...
	)		fr_log(LOG_DST, _lvl, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Definition at line 172 of file log.h.

_FR_LOG_DST_FATAL

#define _FR_LOG_DST_FATAL	(		_fmt,
			...
	)		log_fatal(LOG_DST, __FILE__, __LINE__, _fmt, ## __VA_ARGS__)

Definition at line 174 of file log.h.

_FR_LOG_DST_MARKER

#define _FR_LOG_DST_MARKER	(		_lvl,
			_str,
			_str_len,
			_marker_idx,
			_line_prefix_fmt,
			...
	)		fr_log_marker(LOG_DST, _lvl, __FILE__, __LINE__, _str, _str_len, _marker_idx, _line_prefix_fmt, ## __VA_ARGS__)

Write a log message with marker.

Parameters

[in]	_lvl	log level.
[in]	_str	to markup.
[in]	_str_len	length of subject string. May be SIZE_MAX to print the entire string.
[in]	_marker_idx	Where to place the marker. May be negative.
[in]	_line_prefix_fmt	Prefix to add to all log lines.
[in]	...	Arguments for _line_prefix_fmt.

Definition at line 186 of file log.h.

_FR_LOG_DST_PERROR

#define _FR_LOG_DST_PERROR	(		_lvl,
			_fmt,
			...
	)		fr_log_perror(LOG_DST, _lvl, __FILE__, __LINE__, NULL, _fmt, ## __VA_ARGS__)

Definition at line 173 of file log.h.

_FR_LOG_PREFIX

#define _FR_LOG_PREFIX	(		_lvl,
			_fmt,
			...
	)		_FR_LOG_DST(_lvl, _fmt, ## __VA_ARGS__)

Definition at line 201 of file log.h.

_FR_LOG_PREFIX_FATAL

#define _FR_LOG_PREFIX_FATAL	(		_fmt,
			...
	)		_FR_LOG_DST_FATAL(_fmt, ## __VA_ARGS__)

Definition at line 203 of file log.h.

_FR_LOG_PREFIX_MARKER

#define _FR_LOG_PREFIX_MARKER	(		_lvl,
			_str,
			_str_len,
			_marker_idx,
			_marker
	)		_FR_LOG_DST_MARKER(_lvl, _str, _str_len, _marker_idx, _marker, "")

Definition at line 204 of file log.h.

_FR_LOG_PREFIX_PERROR

#define _FR_LOG_PREFIX_PERROR	(		_lvl,
			_fmt,
			...
	)		_FR_LOG_DST_PERROR(_lvl, _fmt, ## __VA_ARGS__)

Definition at line 202 of file log.h.

_HEX_MARKER

#define _HEX_MARKER	(		_lvl,
			_data,
			_len,
			_slen,
			_error,
			_fmt,
			...
	)

Value:

        if (debug_enabled(L_DBG, _lvl)) do { \
                fr_log_hex_marker(LOG_DST, L_DBG, __FILE__, __LINE__, _data, _len, _slen, _error, _fmt, ## __VA_ARGS__); \
        } while (0)

Pretty print binary data as hex, with output as a wrapped block with addresses and a marker.

Parameters

[in]	_lvl	Debug level at which we start emitting the log message.
[in]	_data	Binary data to print.
[in]	_len	Length of binary data.
[in]	_slen	Where the marker should be placed.
[in]	_error	to print after the marker.
[in]	_fmt	Message to prefix hex output with.
[in]	...	Additional arguments to print.

Definition at line 753 of file log.h.

_HEXDUMP

#define _HEXDUMP	(		_lvl,
			_data,
			_len,
			_fmt,
			...
	)

Value:

        if (debug_enabled(L_DBG, _lvl)) do { \
                fr_log_hex(LOG_DST, L_DBG, __FILE__, __LINE__, _data, _len, _fmt, ## __VA_ARGS__); \
        } while (0)

Pretty print binary data as hex, with output as a wrapped block with addresses.

Parameters

[in]	_lvl	Debug level at which we start emitting the log message.
[in]	_data	Binary data to print.
[in]	_len	Length of binary data.
[in]	_fmt	Message to prefix hex output with.
[in]	...	Additional arguments to print.

Definition at line 733 of file log.h.

_PDEBUG_LOG

#define _PDEBUG_LOG	(		_type,
			_lvl,
			_fmt,
			...
	)		if (fr_debug_lvl >= _lvl) _FR_LOG_PREFIX_PERROR(_type, _fmt, ## __VA_ARGS__)

Definition at line 275 of file log.h.

_RHEXDUMP

#define _RHEXDUMP	(		_lvl,
			_data,
			_len,
			_fmt,
			...
	)

Value:

        if (log_rdebug_enabled(_lvl, request)) do { \
                log_request(L_DBG, _lvl, request, __FILE__, __LINE__, _fmt, ## __VA_ARGS__); \
                log_request_hex(L_DBG, _lvl, request, __FILE__, __LINE__, _data, _len); \
        } while (0)

Pretty print binary data as hex, with output as a wrapped block with addresses.

Parameters

[in]	_lvl	Debug level at which we start emitting the log message.
[in]	_data	Binary data to print.
[in]	_len	Length of binary data.
[in]	_fmt	Message to print as a header to the hex output.
[in]	...	Additional arguments to print.

Definition at line 714 of file log.h.

_RHEXDUMP_INLINE

#define _RHEXDUMP_INLINE	(		_lvl,
			_data,
			_len,
			_fmt,
			...
	)

Value:

        if (log_rdebug_enabled(_lvl, request)) do { \
                log_request(L_DBG, _lvl, request, __FILE__, __LINE__, _fmt " 0x%pH", ## __VA_ARGS__, fr_box_octets(_data, _len)); \
        } while (0)

Pretty print binary data, with hex output inline with message.

Output format is

<msg>0x<hex string> 

.

Parameters

[in]	_lvl	Debug level at which we start emitting the log message.
[in]	_data	Binary data to print.
[in]	_len	Length of binary data.
[in]	_fmt	Message to prefix hex output with.
[in]	...	Additional arguments to print.

Definition at line 696 of file log.h.

DEBUG

#define DEBUG	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG, L_DBG_LVL_1, _fmt, ## __VA_ARGS__)

Definition at line 269 of file log.h.

DEBUG2

#define DEBUG2	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG, L_DBG_LVL_2, _fmt, ## __VA_ARGS__)

Definition at line 270 of file log.h.

DEBUG3

#define DEBUG3	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG, L_DBG_LVL_3, _fmt, ## __VA_ARGS__)

Definition at line 271 of file log.h.

DEBUG4

#define DEBUG4	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG, L_DBG_LVL_MAX, _fmt, ## __VA_ARGS__)

Definition at line 272 of file log.h.

debug_enabled

#define debug_enabled	(		_type,
			_lvl
	)		(((_type & L_DBG) != 0) && (_lvl <= fr_debug_lvl))

Definition at line 104 of file log.h.

DEBUG_ENABLED

#define DEBUG_ENABLED   debug_enabled(L_DBG, L_DBG_LVL_1)

True if global debug level 1 messages are enabled.

Definition at line 262 of file log.h.

DEBUG_ENABLED2

#define DEBUG_ENABLED2   debug_enabled(L_DBG, L_DBG_LVL_2)

True if global debug level 1-2 messages are enabled.

Definition at line 263 of file log.h.

DEBUG_ENABLED3

#define DEBUG_ENABLED3   debug_enabled(L_DBG, L_DBG_LVL_3)

True if global debug level 1-3 messages are enabled.

Definition at line 264 of file log.h.

DEBUG_ENABLED4

#define DEBUG_ENABLED4   debug_enabled(L_DBG, L_DBG_LVL_4)

True if global debug level 1-4 messages are enabled.

Definition at line 265 of file log.h.

DEBUG_ENABLED5

#define DEBUG_ENABLED5   debug_enabled(L_DBG, L_DBG_LVL_MAX)

True if global debug level 1-5 messages are enabled.

Definition at line 266 of file log.h.

DEBUGX

#define DEBUGX	(		_lvl,
			_fmt,
			...
	)		_DEBUG_LOG(L_DBG, _lvl, _fmt, ## __VA_ARGS__)

Definition at line 273 of file log.h.

EDEBUG

#define EDEBUG	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG_ERR, L_DBG_LVL_1, _fmt, ## __VA_ARGS__)

Definition at line 288 of file log.h.

EDEBUG2

#define EDEBUG2	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG_ERR, L_DBG_LVL_2, _fmt, ## __VA_ARGS__)

Definition at line 289 of file log.h.

EDEBUG3

#define EDEBUG3	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG_ERR, L_DBG_LVL_3, _fmt, ## __VA_ARGS__)

Definition at line 290 of file log.h.

EDEBUG4

#define EDEBUG4	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG_ERR, L_DBG_LVL_MAX, _fmt, ## __VA_ARGS__)

Definition at line 291 of file log.h.

EDEBUGX

#define EDEBUGX	(		_lvl,
			_fmt,
			...
	)		_DEBUG_LOG(L_DBG_ERR, _lvl, _fmt, ## __VA_ARGS__)

Definition at line 292 of file log.h.

EMARKER

#define EMARKER	(		_str,
			_marker_idx,
			_marker
	)		_FR_LOG_PREFIX_MARKER(L_ERR, _str, SIZE_MAX, _marker_idx, _marker)

Definition at line 237 of file log.h.

ERROR

#define ERROR	(		_fmt,
			...
	)		_FR_LOG_PREFIX(L_ERR, _fmt, ## __VA_ARGS__)

Definition at line 228 of file log.h.

FATAL

#define FATAL	(		_fmt,
			...
	)		_FR_LOG_PREFIX_FATAL(_fmt, ## __VA_ARGS__)

Definition at line 229 of file log.h.

HEX_MARKER1

#define HEX_MARKER1	(		_data,
			_len,
			_slen,
			_error,
			_fmt,
			...
	)		_HEX_MARKER(L_DBG_LVL_1, _data, _len, _slen, _error, _fmt, ## __VA_ARGS__)

Definition at line 758 of file log.h.

HEX_MARKER2

#define HEX_MARKER2	(		_data,
			_len,
			_slen,
			_error,
			_fmt,
			...
	)		_HEX_MARKER(L_DBG_LVL_2, _data, _len, _slen, _error, _fmt, ## __VA_ARGS__)

Definition at line 759 of file log.h.

HEX_MARKER3

#define HEX_MARKER3	(		_data,
			_len,
			_slen,
			_error,
			_fmt,
			...
	)		_HEX_MARKER(L_DBG_LVL_3, _data, _len, _slen, _error, _fmt, ## __VA_ARGS__)

Definition at line 760 of file log.h.

HEX_MARKER4

#define HEX_MARKER4	(		_data,
			_len,
			_slen,
			_error,
			_fmt,
			...
	)		_HEX_MARKER(L_DBG_LVL_4, _data, _len, _slen, _error, _fmt, ## __VA_ARGS__)

Definition at line 761 of file log.h.

HEXDUMP1

#define HEXDUMP1	(		_data,
			_len,
			_fmt,
			...
	)		_HEXDUMP(L_DBG_LVL_1, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 738 of file log.h.

HEXDUMP2

#define HEXDUMP2	(		_data,
			_len,
			_fmt,
			...
	)		_HEXDUMP(L_DBG_LVL_2, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 739 of file log.h.

HEXDUMP3

#define HEXDUMP3	(		_data,
			_len,
			_fmt,
			...
	)		_HEXDUMP(L_DBG_LVL_3, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 740 of file log.h.

HEXDUMP4

#define HEXDUMP4	(		_data,
			_len,
			_fmt,
			...
	)		_HEXDUMP(L_DBG_LVL_4, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 741 of file log.h.

IMARKER

#define IMARKER	(		_str,
			_marker_idx,
			_marker
	)		_FR_LOG_PREFIX_MARKER(L_INFO, _str, SIZE_MAX, _marker_idx, _marker)

Definition at line 235 of file log.h.

INFO

#define INFO	(		_fmt,
			...
	)		_FR_LOG_PREFIX(L_INFO, _fmt, ## __VA_ARGS__)

Definition at line 226 of file log.h.

LOG_DST

#define LOG_DST   &default_log

Definition at line 170 of file log.h.

log_dst_foreach

#define log_dst_foreach	(		_head,
			_iter
	)		for (log_dst_t *JOIN(_next,_iter), *_iter = _head; JOIN(_next,_iter) = (_head)->next, _iter != NULL; _iter = JOIN(_next,_iter))

Iterate over the contents of a log_dst_t.

The macro is "safe", in that the current iterator variable can be deleted.

The iterators can be nested, so long as the _iter variable names are different.

Parameters

[in]	_head	to iterate over.
[in]	_iter	Name of iteration variable. Will be declared in the scope of the loop.

Definition at line 773 of file log.h.

LOG_PACKET_DEBUG

#define LOG_PACKET_DEBUG	(		_request,
			...
	)		if (RDEBUG_ENABLED) log_request_packet(_request, ## __VA_ARGS__)

Definition at line 133 of file log.h.

PDEBUG

#define PDEBUG	(		_fmt,
			...
	)		_PDEBUG_LOG(L_DBG, L_DBG_LVL_1, _fmt, ## __VA_ARGS__)

Definition at line 276 of file log.h.

PDEBUG2

#define PDEBUG2	(		_fmt,
			...
	)		_PDEBUG_LOG(L_DBG, L_DBG_LVL_2, _fmt, ## __VA_ARGS__)

Definition at line 277 of file log.h.

PDEBUG3

#define PDEBUG3	(		_fmt,
			...
	)		_PDEBUG_LOG(L_DBG, L_DBG_LVL_3, _fmt, ## __VA_ARGS__)

Definition at line 278 of file log.h.

PDEBUG4

#define PDEBUG4	(		_fmt,
			...
	)		_PDEBUG_LOG(L_DBG, L_DBG_LVL_MAX, _fmt, ## __VA_ARGS__)

Definition at line 279 of file log.h.

PDEBUGX

#define PDEBUGX	(		_lvl,
			_fmt,
			...
	)		_PDEBUG_LOG(L_DBG, _lvl, _fmt, ## __VA_ARGS__)

Definition at line 280 of file log.h.

PERROR

#define PERROR	(		_fmt,
			...
	)		_FR_LOG_PREFIX_PERROR(L_ERR, _fmt, ## __VA_ARGS__)

Definition at line 233 of file log.h.

PINFO

#define PINFO	(		_fmt,
			...
	)		_FR_LOG_PREFIX_PERROR(L_INFO, _fmt, ## __VA_ARGS__)

Definition at line 231 of file log.h.

PWARN

#define PWARN	(		_fmt,
			...
	)		_FR_LOG_PREFIX_PERROR(L_WARN, _fmt, ## __VA_ARGS__)

Definition at line 232 of file log.h.

RATE_LIMIT_GLOBAL

#define RATE_LIMIT_GLOBAL	(		_log,
			_fmt,
			...
	)

Value:

do {\
        static fr_rate_limit_t  _rate_limit; \
        RATE_LIMIT_LOCAL(&_rate_limit, _log, _fmt, ##__VA_ARGS__); \
} while (0)

Rate limit messages using a global limiting entry.

Rate limit log messages so they're written a maximum of once per second.

RATE_LIMIT(RERROR, "Home servers alive in pool %s", pool->name));

Note

Rate limits the macro, not the message. If five different messages are produced using the same macro in the same second, only the first will be written to the log.

Parameters

[in]	_log	Logging macro.
[in]	_fmt	printf style format string.
[in]	...	printf arguments.

Definition at line 658 of file log.h.

RATE_LIMIT_GLOBAL_ROPTIONAL

#define RATE_LIMIT_GLOBAL_ROPTIONAL	(		_l_request,
			_l_global,
			_fmt,
			...
	)

Value:

do {\
        static fr_rate_limit_t _rate_limit; \
        RATE_LIMIT_LOCAL_ROPTIONAL(&_rate_limit, _l_request, _l_global, _fmt, ##__VA_ARGS__); \
} while (0)

Rate limit messages using a global limiting entry.

Rate limit log messages so they're written a maximum of once per second.

RATE_LIMIT(RERROR, "Home servers alive in pool %s", pool->name));

Note

Rate limits the macro, not the message. If five different messages are produced using the same macro in the same second, only the first will be written to the log.

Parameters

[in]	_l_request	The name of a R* logging macro e.g. RDEBUG3.
[in]	_l_global	The name of a global logging macro e.g. DEBUG3.
[in]	_fmt	printf style format string.
[in]	...	printf arguments.

Definition at line 680 of file log.h.

RATE_LIMIT_LOCAL

#define RATE_LIMIT_LOCAL	(		_entry,
			_log,
			_fmt,
			...
	)

Value:

do {\
        if (fr_rate_limit_enabled()) {\
                (_entry)->now = fr_time();\
                if (fr_time_to_sec((_entry)->now) != fr_time_to_sec((_entry)->last_complained)) {\
                        (_entry)->last_complained = (_entry)->now;\
                        if (((_entry)->repeated > 0) && (fr_time_delta_to_sec(fr_time_sub((_entry)->now, (_entry)->last_complained)) == 1)) { \
                                _log(_fmt " - repeated %u time(s)", ##__VA_ARGS__, (_entry)->repeated); \
                        } else { \
                                _log(_fmt, ##__VA_ARGS__); \
                        }\
                        (_entry)->repeated = 0; \
                } else { \
                        (_entry)->repeated++; \
                } \
        } else (_log(_fmt, ##__VA_ARGS__));\
} while (0)

Rate limit messages using a local limiting entry.

Rate limit log messages so they're written a maximum of once per second.

RATE_LIMIT(&inst->home_server_alive_rate_limit, RERROR, "Home servers alive in pool %s", pool->name));

Note

Rate limits the macro, not the message. If five different messages are produced using the same macro in the same second, only the first will be written to the log.

Parameters

[in]	_entry	Used to track rate limiting.
[in]	_log	Logging macro.
[in]	_fmt	printf style format string.
[in]	...	printf arguments.

Definition at line 586 of file log.h.

RATE_LIMIT_LOCAL_ROPTIONAL

#define RATE_LIMIT_LOCAL_ROPTIONAL	(		_entry,
			_l_request,
			_l_global,
			_fmt,
			...
	)

Value:

do {\
        if (fr_rate_limit_enabled()) {\
                (_entry)->now = fr_time();\
                if (fr_time_to_sec((_entry)->now) != fr_time_to_sec((_entry)->last_complained)) {\
                        (_entry)->last_complained = (_entry)->now;\
                        if (((_entry)->repeated > 0) && (fr_time_delta_to_sec(fr_time_sub((_entry)->now, (_entry)->last_complained)) == 1)) { \
                                ROPTIONAL(_l_request, _l_global, _fmt " - repeated %u time(s)", ##__VA_ARGS__, (_entry)->repeated); \
                        } else { \
                                ROPTIONAL(_l_request, _l_global, _fmt, ##__VA_ARGS__); \
                        }\
                        (_entry)->repeated = 0; \
                } else { \
                        (_entry)->repeated++; \
                } \
        } else { \
                ROPTIONAL(_l_request, _l_global, _fmt, ##__VA_ARGS__);\
        } \
} while (0)

Rate limit messages using a local limiting entry.

Rate limit log messages so they're written a maximum of once per second. The ROPTIOANL variant allows different logging macros to be used based on whether a request is available.

RATE_LIMIT(&inst->home_server_alive_rate_limit, RERROR, "Home servers alive in pool %s", pool->name));

Note

Rate limits the macro, not the message. If five different messages are produced using the same macro in the same second, only the first will be written to the log.

Parameters

[in]	_entry	Used to track rate limiting.
[in]	_l_request	The name of a R* logging macro e.g. RDEBUG3.
[in]	_l_global	The name of a global logging macro e.g. DEBUG3.
[in]	_fmt	printf style format string.
[in]	...	printf arguments.

Definition at line 623 of file log.h.

RDEBUG

#define RDEBUG	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 358 of file log.h.

RDEBUG2

#define RDEBUG2	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 359 of file log.h.

RDEBUG3

#define RDEBUG3	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 360 of file log.h.

RDEBUG4

#define RDEBUG4	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 361 of file log.h.

RDEBUG_ENABLED

#define RDEBUG_ENABLED   log_rdebug_enabled(L_DBG_LVL_1, request)

True if request debug level 1 messages are enabled.

Definition at line 350 of file log.h.

RDEBUG_ENABLED2

#define RDEBUG_ENABLED2   log_rdebug_enabled(L_DBG_LVL_2, request)

True if request debug level 1-2 messages are enabled.

Definition at line 351 of file log.h.

RDEBUG_ENABLED3

#define RDEBUG_ENABLED3   log_rdebug_enabled(L_DBG_LVL_3, request)

True if request debug level 1-3 messages are enabled.

Definition at line 352 of file log.h.

RDEBUG_ENABLED4

#define RDEBUG_ENABLED4   log_rdebug_enabled(L_DBG_LVL_4, request)

True if request debug level 1-4 messages are enabled.

Definition at line 353 of file log.h.

RDEBUG_ENABLED5

#define RDEBUG_ENABLED5   log_rdebug_enabled(L_DBG_LVL_MAX, request)

True if request debug level 1-5 messages are enabled.

Definition at line 354 of file log.h.

RDEBUG_ENABLEDX

#define RDEBUG_ENABLEDX

(

_x

)

log_rdebug_enabled(_x, request)

True if specified lvl is enabled.

Definition at line 355 of file log.h.

RDEBUGX

#define RDEBUGX	(		_l,
			fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG, _l, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 357 of file log.h.

RDMARKER

#define RDMARKER	(		_str,
			_marker_idx,
			_marker,
			...
	)		RMARKER(L_DBG, L_DBG_LVL_1, _str, _marker_idx, _marker, ## __VA_ARGS__)

Output string with error marker, showing where format error occurred.

These are logged as RDEBUG messages.

  my pet kitty
     ^ kitties are not pets, are nature devouring hell beasts

Warning

If a request_t * is NOT available, or is NULL, this macro must NOT be used.

Parameters

[in]	_str	to mark e.g. "my pet kitty".
[in]	_marker_idx	index e.g. 3 (starts from 0).
[in]	_marker	error message e.g. "kitties are not pets, are nature devouring hell beasts".
[in]	...	arguments for error string.

Definition at line 533 of file log.h.

REDEBUG

#define REDEBUG	(		fmt,
			...
	)		log_request_error(L_DBG_ERR, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 388 of file log.h.

REDEBUG2

#define REDEBUG2	(		fmt,
			...
	)		log_request_error(L_DBG_ERR, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 389 of file log.h.

REDEBUG3

#define REDEBUG3	(		fmt,
			...
	)		log_request_error(L_DBG_ERR, L_DBG_LVL_3,request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 390 of file log.h.

REDEBUG4

#define REDEBUG4	(		fmt,
			...
	)		log_request_error(L_DBG_ERR, L_DBG_LVL_MAX, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 391 of file log.h.

REMARKER

#define REMARKER	(		_str,
			_marker_idx,
			_marker,
			...
	)		RMARKER(L_DBG_ERR, L_DBG_LVL_1, _str, _marker_idx, _marker, ## __VA_ARGS__)

Output string with error marker, showing where format error occurred.

These are logged as RERROR messages.

  my pet kitty
     ^ kitties are not pets, are nature devouring hell beasts

Warning

If a request_t * is NOT available, or is NULL, this macro must NOT be used.

Parameters

[in]	_str	to mark e.g. "my pet kitty".
[in]	_marker_idx	index e.g. 3 (starts from 0).
[in]	_marker	error message e.g. "kitties are not pets, are nature devouring hell beasts".
[in]	...	arguments for error string.

Definition at line 515 of file log.h.

RERROR

#define RERROR	(		fmt,
			...
	)		log_request_error(L_DBG_ERR, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 315 of file log.h.

REXDENT

#define REXDENT

(

)

Value:

        do {\
        if (request->module) {\
                request->log.indent.module -= 2;\
        } else {\
                request->log.indent.unlang -= 2;\
        }\
} while(0)

Exdent (unindent) R* messages by one level.

Note

Has no effect on the indentation of INFO, WARN, ERROR, DEBUG messages, only RINFO, RWARN, RERROR etc...

Definition at line 460 of file log.h.

RHEXDUMP1

#define RHEXDUMP1	(		_data,
			_len,
			_fmt,
			...
	)		_RHEXDUMP(L_DBG_LVL_1, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 720 of file log.h.

RHEXDUMP2

#define RHEXDUMP2	(		_data,
			_len,
			_fmt,
			...
	)		_RHEXDUMP(L_DBG_LVL_2, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 721 of file log.h.

RHEXDUMP3

#define RHEXDUMP3	(		_data,
			_len,
			_fmt,
			...
	)		_RHEXDUMP(L_DBG_LVL_3, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 722 of file log.h.

RHEXDUMP4

#define RHEXDUMP4	(		_data,
			_len,
			_fmt,
			...
	)		_RHEXDUMP(L_DBG_LVL_4, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 723 of file log.h.

RHEXDUMP_INLINE1

#define RHEXDUMP_INLINE1	(		_data,
			_len,
			_fmt,
			...
	)		_RHEXDUMP_INLINE(L_DBG_LVL_1, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 701 of file log.h.

RHEXDUMP_INLINE2

#define RHEXDUMP_INLINE2	(		_data,
			_len,
			_fmt,
			...
	)		_RHEXDUMP_INLINE(L_DBG_LVL_2, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 702 of file log.h.

RHEXDUMP_INLINE3

#define RHEXDUMP_INLINE3	(		_data,
			_len,
			_fmt,
			...
	)		_RHEXDUMP_INLINE(L_DBG_LVL_3, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 703 of file log.h.

RHEXDUMP_INLINE4

#define RHEXDUMP_INLINE4	(		_data,
			_len,
			_fmt,
			...
	)		_RHEXDUMP_INLINE(L_DBG_LVL_4, _data, _len, _fmt, ## __VA_ARGS__)

Definition at line 704 of file log.h.

RIDEBUG

#define RIDEBUG	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG_INFO, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 368 of file log.h.

RIDEBUG2

#define RIDEBUG2	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG_INFO, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 369 of file log.h.

RIDEBUG3

#define RIDEBUG3	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG_INFO, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 370 of file log.h.

RIDEBUG4

#define RIDEBUG4	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG_INFO, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 371 of file log.h.

RINDENT

#define RINDENT

(

)

Value:

        do {\
        if (request->module) {\
                request->log.indent.module += 2;\
        } else {\
                request->log.indent.unlang += 2;\
        }\
} while(0)

Indent R* messages by one level.

Note

Has no effect on the indentation of INFO, WARN, ERROR, DEBUG messages, only RINFO, RWARN, RERROR etc...

Definition at line 447 of file log.h.

RINDENT_RESTORE

#define RINDENT_RESTORE	(		_request,
			_x
	)

Value:

                do { \
                request->log.indent = (_x)->indent; \
        } while (0)

Definition at line 409 of file log.h.

RINDENT_SAVE

#define RINDENT_SAVE	(		_x,
			_request
	)

Value:

                do { \
                (_x)->indent = request->log.indent; \
        } while (0)

Save indentation for later restoral.

This call avoids the need to manually REXDENT on error paths. We can just restore and return.

Definition at line 405 of file log.h.

RINFO

#define RINFO	(		fmt,
			...
	)		log_request(L_INFO, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 313 of file log.h.

RMARKER

#define RMARKER	(		_type,
			_lvl,
			_str,
			_marker_idx,
			_marker,
			...
	)

Value:

        log_request_marker(_type, _lvl, request, \
                           __FILE__, __LINE__, \
                           _str, SIZE_MAX, _marker_idx, _marker, ## __VA_ARGS__)

Output string with error marker, showing where format error occurred.

  my pet kitty
     ^ kitties are not pets, are nature devouring hell beasts

Warning

If a request_t * is NOT available, or is NULL, this macro must NOT be used.

Parameters

[in]	_type	log category, a fr_log_type_t value.
[in]	_lvl	log priority, a fr_log_lvl_t value.
[in]	_str	to mark e.g. "my pet kitty".
[in]	_marker_idx	index e.g. 3 (starts from 0).
[in]	_marker	error message e.g. "kitties are not pets, are nature devouring hell beasts".
[in]	...	arguments for error string.

Definition at line 486 of file log.h.

ROPTIONAL

#define ROPTIONAL	(		_l_request,
			_l_global,
			_fmt,
			...
	)

Value:

do {\
        if (request) {\
                _l_request(_fmt, ## __VA_ARGS__);\
        } else {\
                _l_global(_fmt, ## __VA_ARGS__);\
        }\
} while (0)

Use different logging functions depending on whether request is NULL or not.

This is useful for areas of code which are run on server startup, and when processing requests.

Parameters

[in]	_l_request	The name of a R* logging macro e.g. RDEBUG3.
[in]	_l_global	The name of a global logging macro e.g. DEBUG3.
[in]	_fmt	printf style format string.
[in]	...	printf arguments.

Definition at line 545 of file log.h.

ROPTIONAL_ENABLED

#define ROPTIONAL_ENABLED	(		_e_request,
			_e_global
	)		((request && _e_request) || _e_global)

Check if a debug level is set by the request (if !NULL) or by the global log.

Parameters

[in]	_e_request	Enabled macro to use for requests.
[in]	_e_global	Enabled macro to use for global.

Definition at line 559 of file log.h.

RPDEBUG

#define RPDEBUG	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 363 of file log.h.

RPDEBUG2

#define RPDEBUG2	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 364 of file log.h.

RPDEBUG3

#define RPDEBUG3	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 365 of file log.h.

RPDEBUG4

#define RPDEBUG4	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 366 of file log.h.

RPEDEBUG

#define RPEDEBUG	(		fmt,
			...
	)		log_request_perror(L_DBG_ERR, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 393 of file log.h.

RPEDEBUG2

#define RPEDEBUG2	(		fmt,
			...
	)		log_request_perror(L_DBG_ERR, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 394 of file log.h.

RPEDEBUG3

#define RPEDEBUG3	(		fmt,
			...
	)		log_request_perror(L_DBG_ERR, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 395 of file log.h.

RPEDEBUG4

#define RPEDEBUG4	(		fmt,
			...
	)		log_request_perror(L_DBG_ERR, L_DBG_LVL_MAX, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 396 of file log.h.

RPERROR

#define RPERROR	(		fmt,
			...
	)		log_request_perror(L_DBG_ERR, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 319 of file log.h.

RPIDEBUG

#define RPIDEBUG	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG_INFO, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 373 of file log.h.

RPIDEBUG2

#define RPIDEBUG2	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG_INFO, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 374 of file log.h.

RPIDEBUG3

#define RPIDEBUG3	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG_INFO, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 375 of file log.h.

RPIDEBUG4

#define RPIDEBUG4	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG_INFO, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 376 of file log.h.

RPINFO

#define RPINFO	(		fmt,
			...
	)		log_request_perror(L_DBG_INFO, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 317 of file log.h.

RPWARN

#define RPWARN	(		fmt,
			...
	)		log_request_perror(L_DBG_WARN, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 318 of file log.h.

RPWDEBUG

#define RPWDEBUG	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG_WARN, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 383 of file log.h.

RPWDEBUG2

#define RPWDEBUG2	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG_WARN, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 384 of file log.h.

RPWDEBUG3

#define RPWDEBUG3	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG_WARN, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 385 of file log.h.

RPWDEBUG4

#define RPWDEBUG4	(		fmt,
			...
	)		do { if (request->log.lvl) log_request_perror(L_DBG_WARN, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 386 of file log.h.

RWARN

#define RWARN	(		fmt,
			...
	)		log_request(L_DBG_WARN, L_DBG_LVL_OFF, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__)

Definition at line 314 of file log.h.

RWDEBUG

#define RWDEBUG	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG_WARN, L_DBG_LVL_1, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 378 of file log.h.

RWDEBUG2

#define RWDEBUG2	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG_WARN, L_DBG_LVL_2, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 379 of file log.h.

RWDEBUG3

#define RWDEBUG3	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG_WARN, L_DBG_LVL_3, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 380 of file log.h.

RWDEBUG4

#define RWDEBUG4	(		fmt,
			...
	)		do { if (request->log.lvl) log_request(L_DBG_WARN, L_DBG_LVL_4, request, __FILE__, __LINE__, fmt, ## __VA_ARGS__); } while(0)

Definition at line 381 of file log.h.

WARN

#define WARN	(		_fmt,
			...
	)		_FR_LOG_PREFIX(L_WARN, _fmt, ## __VA_ARGS__)

Definition at line 227 of file log.h.

WDEBUG

#define WDEBUG	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG_WARN, L_DBG_LVL_1, _fmt, ## __VA_ARGS__)

Definition at line 282 of file log.h.

WDEBUG2

#define WDEBUG2	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG_WARN, L_DBG_LVL_2, _fmt, ## __VA_ARGS__)

Definition at line 283 of file log.h.

WDEBUG3

#define WDEBUG3	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG_WARN, L_DBG_LVL_3, _fmt, ## __VA_ARGS__)

Definition at line 284 of file log.h.

WDEBUG4

#define WDEBUG4	(		_fmt,
			...
	)		_DEBUG_LOG(L_DBG_WARN, L_DBG_LVL_MAX, _fmt, ## __VA_ARGS__)

Definition at line 285 of file log.h.

WDEBUGX

#define WDEBUGX	(		_lvl,
			_fmt,
			...
	)		_DEBUG_LOG(L_DBG_WARN, _lvl, _fmt, ## __VA_ARGS__)

Definition at line 286 of file log.h.

WMARKER

#define WMARKER	(		_str,
			_marker_idx,
			_marker
	)		_FR_LOG_PREFIX_MARKER(L_WARN, _str, SIZE_MAX, _marker_idx, _marker)

Definition at line 236 of file log.h.

Typedef Documentation

CONF_SECTION

typedef struct cf_section CONF_SECTION

Definition at line 157 of file log.h.

log_dst_t

typedef struct log_dst log_dst_t

A logging destination, consisting of a function and its context.

Definition at line 39 of file log.h.

log_func_t

typedef void(* log_func_t) (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *fmt, va_list ap, void *uctx)

Logging callback to write log messages to a destination.

This allows the logging destination to be customised on a per request basis.

Note

Logging functions must not block waiting on I/O.

Parameters

[in]	type	What type of message this is (error, warn, info, debug).
[in]	lvl	At what logging level this message should be output.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	request	The current request.
[in]	fmt	sprintf style fmt string.
[in]	ap	Arguments for the fmt string.
[in]	uctx	Context data for the log function. Usually an fr_log_t for vlog_request.

Definition at line 66 of file log.h.

log_request_func_t

typedef void(* log_request_func_t) (fr_log_type_t type, fr_log_lvl_t lvl, request_t *request, char const *file, int line, char const *fmt,...)

Function signature for log_request functions.

Definition at line 93 of file log.h.

rindent_t

typedef struct rindent_s rindent_t

Function Documentation

log_dst_by_name()

fr_log_t * log_dst_by_name

(

char const *

name

)

Get a logging destination by name.

Definition at line 1129 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

log_fatal()

void log_fatal	(	fr_log_t const *	log,
		char const *	file,
		int	line,
		char const *	fmt,
			...
	)

Log a fatal error, then exit.

Definition at line 1094 of file log.c.

Here is the call graph for this function:

log_global_free()

void log_global_free

(

void

)

Definition at line 1359 of file log.c.

Here is the caller graph for this function:

log_global_init()

int log_global_init	(	fr_log_t *	log,
		bool	daemonize
	)

Initialises the server logging functionality, and the underlying libfreeradius log.

Note

Call log free when the server is done to fix any spurious memory leaks.

Parameters

[in]	log	Logging parameters.
[in]	daemonize	Changes what we do with stdout/stderr.

Returns

• 0 on success.
• -1 on failure.

Definition at line 1323 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

log_parse_section()

int log_parse_section

(

CONF_SECTION *

cs

)

Parse a named logging section.

Todo:

• we should probably allow for TCP sockets, too. But then those can block. So we then also need a way to buffer outbound log messages, and discard log messages if the buffer is full.

This should probably be done with a FILE*, and L_DST_FUNC.

Definition at line 1188 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

log_rdebug_enabled()

bool log_rdebug_enabled ( fr_log_lvl_t  lvl, request_t const *  request  )

inline

Whether a request specific debug message should be logged.

Parameters

lvl	of debugging this message should be logged at.
request	The current request.

Returns

• true if message should be logged.
• false if message shouldn't be logged.

Definition at line 267 of file log.c.

Here is the caller graph for this function:

log_request()

void log_request	(	fr_log_type_t	type,
		fr_log_lvl_t	lvl,
		request_t *	request,
		char const *	file,
		int	line,
		char const *	fmt,
			...
	)

Marshal variadic log arguments into a va_list and pass to normal logging functions.

See also

log_request_error for more details.

Parameters

[in]	type	the log category.
[in]	lvl	of debugging this message should be logged at.
[in]	request	The current request.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	fmt	with printf style substitution tokens.
[in]	...	Substitution arguments.

Definition at line 610 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

log_request_error()

void log_request_error	(	fr_log_type_t	type,
		fr_log_lvl_t	lvl,
		request_t *	request,
		char const *	file,
		int	line,
		char const *	fmt,
			...
	)

Marshal variadic log arguments into a va_list and pass to error logging functions.

This could all be done in a macro, but it turns out some implementations of the variadic macros do not work at all well if the va_list being written to is further up the stack (which is required as you still need a function to convert the ellipsis into a va_list).

So, we use this small wrapper function instead, which will hopefully guarantee consistent behaviour.

Parameters

[in]	type	the log category.
[in]	lvl	of debugging this message should be logged at.
[in]	request	The current request.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	fmt	with printf style substitution tokens.
[in]	...	Substitution arguments.

Definition at line 644 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

log_request_fd_event()

void log_request_fd_event	(	UNUSED fr_event_list_t *	el,
		int	fd,
		UNUSED int	flags,
		void *	uctx
	)

Function to provide as the readable callback to the event loop.

Writes any data read from a file descriptor to the request log, tries very hard not to chop lines in the middle, but will split at 1024 byte boundaries if forced to.

Parameters

[in]	el	UNUSED
[in]	fd	UNUSED
[in]	flags	UNUSED
[in]	uctx	Pointer to a log_fd_event_ctx_t

Definition at line 1011 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

log_request_hex()

void log_request_hex	(	fr_log_type_t	type,
		fr_log_lvl_t	lvl,
		request_t *	request,
		char const *	file,
		int	line,
		uint8_t const *	data,
		size_t	data_len
	)

Definition at line 983 of file log.c.

Here is the call graph for this function:

log_request_marker()

void log_request_marker	(	fr_log_type_t	type,
		fr_log_lvl_t	lvl,
		request_t *	request,
		char const *	file,
		int	line,
		char const *	str,
		size_t	str_len,
		ssize_t	marker_idx,
		char const *	marker_fmt,
			...
	)

Write the string being parsed, and a marker showing where the parse error occurred.

Parameters

[in]	type	the log category.
[in]	lvl	of debugging this message should be logged at.
[in]	request	The current request.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	str	Subject string we're printing a marker for.
[in]	str_len	Subject string length. Use SIZE_MAX for the length of the string.
[in]	marker_idx	The position of the marker relative to the string.
[in]	marker_fmt	What the parse error was.
[in]	...	Arguments for fmt string.

Definition at line 934 of file log.c.

Here is the call graph for this function:

log_request_packet()

void log_request_packet	(	request_t *	request,
		fr_packet_t *	packet,
		fr_pair_list_t *	list,
		fr_dict_attr_t const *	type_da,
		bool	received,
		bool	id
	)

Print a packet which we received or sent.

Parameters

[in]	request	to read logging params from.
[in]	packet	the packet in question
[in]	list	to print.
[in]	type_da	of Packet-Type
[in]	received	is this packet being received or being sent
[in]	id	do we log IDs, too

Definition at line 853 of file log.c.

Here is the call graph for this function:

log_request_pair()

void log_request_pair	(	fr_log_lvl_t	lvl,
		request_t *	request,
		fr_pair_t const *	parent,
		fr_pair_t const *	vp,
		char const *	prefix
	)

Print a fr_pair_t.

Parameters

[in]	lvl	Debug lvl (1-4).
[in]	request	to read logging params from.
[in]	parent	of pair to print, may be NULL.
[in]	vp	to print.
[in]	prefix	(optional).

Definition at line 787 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

log_request_pair_list()

void log_request_pair_list	(	fr_log_lvl_t	lvl,
		request_t *	request,
		fr_pair_t const *	parent,
		fr_pair_list_t const *	vps,
		char const *	prefix
	)

Print a fr_pair_list_t.

Parameters

[in]	lvl	Debug lvl (1-4).
[in]	request	to read logging params from.
[in]	parent	of vps to print, may be NULL.
[in]	vps	to print.
[in]	prefix	(optional).

Definition at line 828 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

log_request_perror()

void log_request_perror	(	fr_log_type_t	type,
		fr_log_lvl_t	lvl,
		request_t *	request,
		char const *	file,
		int	line,
		char const *	fmt,
			...
	)

Drain any outstanding messages from the fr_strerror buffers.

This function drains any messages from fr_strerror buffer adding a prefix (fmt) to the first message.

Parameters

[in]	type	the log category.
[in]	lvl	of debugging this message should be logged at.
[in]	request	The current request.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	fmt	with printf style substitution tokens.
[in]	...	Substitution arguments.

Definition at line 681 of file log.c.

Here is the call graph for this function:

log_request_proto_pair_list()

void log_request_proto_pair_list	(	fr_log_lvl_t	lvl,
		request_t *	request,
		fr_pair_t const *	parent,
		fr_pair_list_t const *	vps,
		char const *	prefix
	)

Print a list of protocol fr_pair_ts.

Parameters

[in]	lvl	Debug lvl (1-4).
[in]	request	to read logging params from.
[in]	parent	of vps to print, may be NULL.
[in]	vps	to print.
[in]	prefix	(optional).

Definition at line 902 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

vlog_request()

void vlog_request	(	fr_log_type_t	type,
		fr_log_lvl_t	lvl,
		request_t *	request,
		char const *	file,
		int	line,
		char const *	fmt,
		va_list	ap,
		void *	uctx
	)

Send a log message to its destination, possibly including fields from the request.

Parameters

[in]	type	of log message, L_ERR, L_WARN, L_INFO, L_DBG.
[in]	lvl	Minimum required server or request level to output this message.
[in]	request	The current request.
[in]	file	src file the log message was generated in.
[in]	line	number the log message was generated on.
[in]	fmt	with printf style substitution tokens.
[in]	ap	Substitution arguments.
[in]	uctx	The fr_log_t specifying the destination for log messages.

Definition at line 293 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

log_destination_table

fr_table_num_sorted_t const log_destination_table[]

extern

Definition at line 186 of file log.c.

log_destination_table_len

size_t log_destination_table_len

extern

Definition at line 194 of file log.c.

syslog_facility_table

fr_table_num_sorted_t const syslog_facility_table[]

extern

Syslog facility table.

Maps syslog facility keywords, to the syslog facility macros defined in the system's syslog.h.

Note

Not all facilities are supported by every operating system. If a facility is unavailable it will not appear in the table.

Definition at line 66 of file log.c.

syslog_facility_table_len

size_t syslog_facility_table_len

extern

Definition at line 143 of file log.c.

syslog_severity_table

fr_table_num_sorted_t const syslog_severity_table[]

extern

Syslog severity table.

Maps syslog severity keywords, to the syslog severity macros defined in the system's syslog.h file.

Definition at line 151 of file log.c.

syslog_severity_table_len

size_t syslog_severity_table_len

extern

Definition at line 184 of file log.c.