log.c File Reference

Logging functions used by the server core. More...

#include <freeradius-devel/util/debug.h>
#include <freeradius-devel/util/dict.h>
#include <freeradius-devel/util/log.h>
#include <freeradius-devel/util/syserror.h>
#include <freeradius-devel/util/file.h>
#include <freeradius-devel/server/log.h>
#include <freeradius-devel/server/pair.h>
#include <freeradius-devel/server/util.h>
#include <freeradius-devel/unlang/xlat.h>
#include <fcntl.h>
#include <sys/file.h>
#include <pthread.h>

Include dependency graph for log.c:

Go to the source code of this file.

Data Structures
struct	fr_log_src_t
struct	fr_log_track_t

Functions
static int	_fr_log_request_oid_buff_free (void *arg)
	Cleanup the memory pool used by the OID sbuff.
static int	_fr_vlog_request_pool_free (void *arg)
	Cleanup the memory pool used by vlog_request.
static int	_log_free (fr_log_t *log)
static int8_t	_log_track_filename_cmp (void const *two, void const *one)
static int8_t	_log_track_name_cmp (void const *two, void const *one)
static void	log_always (fr_log_t const *log, fr_log_type_t type, char const *file, int line, char const *fmt,...)
	Send a server log message to its destination without evaluating its debug level.
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.
static void	log_register_dst (char const *name, fr_log_t *log, CONF_SECTION *cs)
	Register a logging destination.
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_fmt,...)
	Write the string being parsed, and a marker showing where the parse error occurred.
static fr_sbuff_t *	log_request_oid_buff (void)
	Allocate an extensible sbuff for printing OID strings.
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 *vps, char const *prefix)
	Print a list of protocol fr_pair_ts.
static void	vlog_module_failure_msg (request_t *request, char const *fmt, va_list ap)
	Add a module failure message fr_pair_t to the 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.

Variables
static fr_dict_attr_t const *	attr_module_failure_message
static fr_dict_t const *	dict_freeradius
static fr_rb_tree_t *	dst_tree = NULL
static fr_rb_tree_t *	filename_tree = NULL
static _Thread_local fr_sbuff_t *	fr_log_request_oid_buff
static _Thread_local TALLOC_CTX *	fr_vlog_request_pool
static const conf_parser_t	log_config []
static char const *	log_destination = NULL
fr_table_num_sorted_t const	log_destination_table []
size_t	log_destination_table_len = NUM_ELEMENTS(log_destination_table)
fr_dict_autoload_t	log_dict []
fr_dict_attr_autoload_t	log_dict_attr []
static bool	log_timestamp
static bool	log_timestamp_is_set
static char const	spaces [] = " "
static fr_rb_tree_t *	src_tree = NULL
fr_table_num_sorted_t const	syslog_facility_table []
	Syslog facility table.
size_t	syslog_facility_table_len = NUM_ELEMENTS(syslog_facility_table)
fr_table_num_sorted_t const	syslog_severity_table []
	Syslog severity table.
size_t	syslog_severity_table_len = NUM_ELEMENTS(syslog_severity_table)

Detailed Description

Logging functions used by the server core.

Id

1d75fcd03baf3eea974e11e0848308ab2d2eac43

Copyright

2000,2006 The FreeRADIUS server project

2000 Miquel van Smoorenburg (mique.nosp@m.ls@c.nosp@m.istro.nosp@m.n.nl)

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

2001 Chad Miller (cmill.nosp@m.er@s.nosp@m.urfso.nosp@m.uth..nosp@m.com)

Definition in file log.c.

---

Data Structure Documentation

fr_log_src_t

struct fr_log_src_t

Definition at line 223 of file log.c.

Collaboration diagram for fr_log_src_t:

Data Fields
uint32_t	id	LOG_ID of this source.
fr_rb_node_t	id_node	tree by ID
fr_log_t **	log	where the logs should go
char const *	name	name of this logging source
fr_rb_node_t	name_node	tree by name only
fr_log_t *	original	the original fr_log_t

fr_log_track_t

struct fr_log_track_t

Definition at line 214 of file log.c.

Collaboration diagram for fr_log_track_t:

Data Fields
CONF_SECTION *	cs	where this log configuration came from
fr_rb_node_t	filename_node	tree by name
fr_log_t *	log	pointer to the log structure
char const *	name	name of this logging destination
fr_rb_node_t	name_node	tree by name

Function Documentation

_fr_log_request_oid_buff_free()

static int _fr_log_request_oid_buff_free ( void *  arg )

static

Cleanup the memory pool used by the OID sbuff.

Definition at line 734 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_fr_vlog_request_pool_free()

static int _fr_vlog_request_pool_free ( void *  arg )

static

Cleanup the memory pool used by vlog_request.

Definition at line 277 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

_log_free()

static int _log_free ( fr_log_t *  log )

static

Definition at line 1083 of file log.c.

Here is the caller graph for this function:

_log_track_filename_cmp()

static int8_t _log_track_filename_cmp ( void const *  two, void const *  one  )

static

Definition at line 1241 of file log.c.

Here is the caller graph for this function:

_log_track_name_cmp()

static int8_t _log_track_name_cmp ( void const *  two, void const *  one  )

static

Definition at line 1233 of file log.c.

Here is the caller graph for this function:

log_always()

static void log_always ( fr_log_t const *  log, fr_log_type_t  type, char const *  file, int  line, char const *  fmt,   ...  )

static

Send a server log message to its destination without evaluating its debug level.

Parameters

[in]	log	destination.
[in]	type	of log message.
[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 248 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

log_dst_by_name()

fr_log_t * log_dst_by_name

(

char const *

name

)

Get a logging destination by name.

Definition at line 1072 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 1037 of file log.c.

Here is the call graph for this function:

log_global_free()

void log_global_free

(

void

)

Definition at line 1301 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 1265 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 1130 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_register_dst()

static void log_register_dst ( char const *  name, fr_log_t *  log, CONF_SECTION *  cs  )

static

Register a logging destination.

Definition at line 1051 of file log.c.

Here is the call graph for this function:

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 645 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 954 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 926 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 884 of file log.c.

Here is the call graph for this function:

log_request_oid_buff()

static fr_sbuff_t * log_request_oid_buff ( void  )

inlinestatic

Allocate an extensible sbuff for printing OID strings.

Definition at line 742 of file log.c.

Here is the call graph for this function:

Here is the caller 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 779 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 677 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 852 of file log.c.

Here is the call graph for this function:

Here is the caller graph for this function:

vlog_module_failure_msg()

static void vlog_module_failure_msg ( request_t *  request, char const *  fmt, va_list  ap  )

static

Add a module failure message fr_pair_t to the request.

Parameters

[in]	request	The current request.
[in]	fmt	with printf style substitution tokens.
[in]	ap	Substitution arguments.

Definition at line 565 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

attr_module_failure_message

fr_dict_attr_t const* attr_module_failure_message

static

Definition at line 206 of file log.c.

dict_freeradius

fr_dict_t const* dict_freeradius

static

Definition at line 198 of file log.c.

dst_tree

fr_rb_tree_t* dst_tree = NULL

static

Definition at line 233 of file log.c.

filename_tree

fr_rb_tree_t* filename_tree = NULL

static

Definition at line 234 of file log.c.

fr_log_request_oid_buff

_Thread_local fr_sbuff_t* fr_log_request_oid_buff

static

Definition at line 56 of file log.c.

fr_vlog_request_pool

_Thread_local TALLOC_CTX* fr_vlog_request_pool

static

Definition at line 55 of file log.c.

log_config

const conf_parser_t log_config[]

static

Initial value:

= {
        { FR_CONF_POINTER("destination", FR_TYPE_STRING, 0, &log_destination), .dflt = "file" },
 
 
 
 
 
 
 
 
 
 
 
 
 
        { FR_CONF_POINTER_IS_SET("timestamp", FR_TYPE_BOOL, 0, &log_timestamp) },
        { FR_CONF_OFFSET("file", fr_log_t, file), },
        { FR_CONF_OFFSET("colourise", fr_log_t, colourise) },
        { FR_CONF_OFFSET("line_number", fr_log_t, line_number) },
        { FR_CONF_OFFSET("use_utc", fr_log_t, dates_utc) },
        { FR_CONF_OFFSET("print_level", fr_log_t, print_level) },
        CONF_PARSER_TERMINATOR
}

Definition at line 1098 of file log.c.

log_destination

char const* log_destination = NULL

static

Definition at line 1091 of file log.c.

log_destination_table

fr_table_num_sorted_t const log_destination_table[]

Initial value:

= {
        { L("file"),            L_DST_FILES     },
        { L("files"),           L_DST_FILES     },
        { L("null"),            L_DST_NULL      },
        { L("stderr"),          L_DST_STDERR    },
        { L("stdout"),          L_DST_STDOUT    },
        { L("syslog"),          L_DST_SYSLOG    },
}

Definition at line 186 of file log.c.

log_destination_table_len

size_t log_destination_table_len = NUM_ELEMENTS(log_destination_table)

Definition at line 194 of file log.c.

log_dict

fr_dict_autoload_t log_dict

Initial value:

= {
        { .out = &dict_freeradius, .proto = "freeradius" },
        DICT_AUTOLOAD_TERMINATOR
}

Definition at line 201 of file log.c.

log_dict_attr

fr_dict_attr_autoload_t log_dict_attr

Initial value:

= {
        { .out = &attr_module_failure_message, .name = "Module-Failure-Message", .type = FR_TYPE_STRING, .dict = &dict_freeradius },
        DICT_AUTOLOAD_TERMINATOR
}

Definition at line 209 of file log.c.

log_timestamp

bool log_timestamp

static

Definition at line 1092 of file log.c.

log_timestamp_is_set

bool log_timestamp_is_set

static

Definition at line 1093 of file log.c.

spaces

char const spaces[] = " "

static

Definition at line 196 of file log.c.

src_tree

fr_rb_tree_t* src_tree = NULL

static

Definition at line 235 of file log.c.

syslog_facility_table

fr_table_num_sorted_t const syslog_facility_table[]

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 = NUM_ELEMENTS(syslog_facility_table)

Definition at line 143 of file log.c.

syslog_severity_table

fr_table_num_sorted_t const syslog_severity_table[]

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 = NUM_ELEMENTS(syslog_severity_table)

Definition at line 184 of file log.c.