logger.h File Reference

Support for logging to various files, console and syslog Configuration in file logger.conf. More...

#include "asterisk/options.h"

Include dependency graph for include/asterisk/logger.h:

Go to the source code of this file.

Macros
#define	__LOG_DEBUG   0
#define	__LOG_DTMF   6
#define	__LOG_ERROR   4
#define	__LOG_NOTICE   2
#define	__LOG_TRACE   1
#define	__LOG_VERBOSE   5
#define	__LOG_WARNING   3
#define	_A_   __FILE__, __LINE__, __FUNCTION__
#define	_TRACE_PREFIX_   _TRACE_PREFIX_DEFAULT_
#define	_TRACE_PREFIX_DEFAULT_   _A_
#define	AST_CALLID_BUFFER_LENGTH   13
#define	ast_debug(level, ...)
	Log a DEBUG message.
#define	AST_LOG_DEBUG   __LOG_DEBUG, _A_
#define	AST_LOG_DTMF   __LOG_DTMF, _A_
#define	ast_log_dynamic_level(level, ...)   ast_log(level, _A_, __VA_ARGS__)
	Send a log message to a dynamically registered log level.
#define	AST_LOG_ERROR   __LOG_ERROR, _A_
#define	AST_LOG_NOTICE   __LOG_NOTICE, _A_
#define	AST_LOG_TRACE   __LOG_TRACE, _A_
#define	AST_LOG_VERBOSE   __LOG_VERBOSE, _A_
#define	AST_LOG_WARNING   __LOG_WARNING, _A_
#define	ast_trace(level, ...)    ast_debug(level < 0 ? __scope_level : level, " " __VA_ARGS__)
#define	ast_trace_dec_indent()
#define	ast_trace_get_indent()   (0)
#define	ast_trace_inc_indent()
#define	ast_trace_log(__level, __log_level, ...)
#define	ast_trace_raw(level, indent_type, ...)    ast_debug(level < 0 ? __scope_level : level, " " __VA_ARGS__)
#define	ast_trace_set_indent(indent)
#define	ast_verb(level, ...)
#define	ast_verb_callid(level, callid, ...)
#define	ast_verbose(...)   __ast_verbose(_A_, -1, __VA_ARGS__)
#define	ast_verbose_callid(callid, ...)   __ast_verbose_callid(_A_, -1, callid, __VA_ARGS__)
#define	DEBUG_ATLEAST(level)
#define	DEBUG_M(a)
#define	EVENTLOG   "event_log"
#define	LOG_DEBUG   __LOG_DEBUG, _A_
#define	LOG_DTMF   __LOG_DTMF, _A_
#define	LOG_ERROR   __LOG_ERROR, _A_
#define	LOG_NOTICE   __LOG_NOTICE, _A_
#define	LOG_TRACE   __LOG_TRACE, _A_
#define	LOG_VERBOSE   __LOG_VERBOSE, _A_
#define	LOG_WARNING   __LOG_WARNING, _A_
#define	NUMLOGLEVELS   32
#define	QUEUELOG   "queue_log"
#define	SCOPE_CALL(level, __funcname, ...)    __funcname(__VA_ARGS__)
#define	SCOPE_CALL_WITH_INT_RESULT(level, __funcname, ...)    __funcname(__VA_ARGS__)
#define	SCOPE_CALL_WITH_RESULT(level, __var, __funcname, ...)    __funcname(__VA_ARGS__)
#define	SCOPE_ENTER(level, ...)
#define	SCOPE_ENTER_TASK(level, indent, ...)
#define	SCOPE_EXIT(...)    ast_debug(__scope_level, " " __VA_ARGS__)
#define	SCOPE_EXIT_EXPR(__expr, ...)
#define	SCOPE_EXIT_LOG(__log_level, ...)
#define	SCOPE_EXIT_LOG_EXPR(__expr, __log_level, ...)
#define	SCOPE_EXIT_LOG_RTN(__log_level, ...)
#define	SCOPE_EXIT_LOG_RTN_VALUE(__value, __log_level, ...)
#define	SCOPE_EXIT_RTN(...)
#define	SCOPE_EXIT_RTN_VALUE(__return_value, ...)
#define	SCOPE_TRACE(__level, ...)
#define	TRACE_ATLEAST(level)
#define	VERBOSE_HASMAGIC(x)   (*(signed char *) (x) < 0)
#define	VERBOSE_MAGIC2LEVEL(x)   (((char) -*(signed char *) (x)) - 1)
#define	VERBOSE_PREFIX_1   " "
#define	VERBOSE_PREFIX_10   " > "
#define	VERBOSE_PREFIX_2   " == "
#define	VERBOSE_PREFIX_3   " -- "
#define	VERBOSE_PREFIX_4   " > "
#define	VERBOSE_PREFIX_5   " > "
#define	VERBOSE_PREFIX_6   " > "
#define	VERBOSE_PREFIX_7   " > "
#define	VERBOSE_PREFIX_8   " > "
#define	VERBOSE_PREFIX_9   " > "
#define	VERBOSITY_ATLEAST(level)   ((level) <= ast_verb_sys_level)

Typedefs
typedef unsigned int	ast_callid

Enumerations
enum	ast_logger_results { AST_LOGGER_SUCCESS = 0 , AST_LOGGER_FAILURE = 1 , AST_LOGGER_DECLINE = -1 , AST_LOGGER_ALLOC_ERROR = -2 }
enum	ast_trace_indent_type {   AST_TRACE_INDENT_SAME = 0 , AST_TRACE_INDENT_INC_BEFORE , AST_TRACE_INDENT_INC_AFTER , AST_TRACE_INDENT_DEC_BEFORE ,   AST_TRACE_INDENT_DEC_AFTER , AST_TRACE_INDENT_PROVIDED , AST_TRACE_INDENT_NONE }
	Controls if and when indenting is applied. More...

Functions
void	__ast_verbose (const char *file, int line, const char *func, int level, const char *fmt,...)
	Send a verbose message (based on verbose level)
void	__ast_verbose_ap (const char *file, int line, const char *func, int level, ast_callid callid, const char *fmt, va_list ap)
void	__ast_verbose_callid (const char *file, int line, const char *func, int level, ast_callid callid, const char *fmt,...)
	Send a verbose message (based on verbose level) with deliberately specified callid.
void	ast_callid_strnprint (char *buffer, size_t buffer_size, ast_callid callid)
	copy a string representation of the callid into a target string
int	ast_callid_threadassoc_add (ast_callid callid)
	Adds a known callid to thread storage of the calling thread.
int	ast_callid_threadassoc_change (ast_callid callid)
	Sets what is stored in the thread storage to the given callid if it does not match what is already there.
int	ast_callid_threadassoc_remove (void)
	Removes callid from thread storage of the calling thread.
int	ast_callid_threadstorage_auto (ast_callid *callid)
	Checks thread storage for a callid and stores a reference if it exists. If not, then a new one will be created, bound to the thread, and a reference to it will be stored.
void	ast_callid_threadstorage_auto_clean (ast_callid callid, int callid_created)
	Use in conjunction with ast_callid_threadstorage_auto. Cleans up the references and if the callid was created by threadstorage_auto, unbinds the callid from the threadstorage.
void	ast_child_verbose (int level, const char *fmt,...)
void	ast_console_puts (const char *string)
	write the string to the root console, and all attached network console clients
void	ast_console_puts_mutable (const char *string, int level)
	log the string to the console, and all attached console clients
void	ast_console_puts_mutable_full (const char *message, int level, int sublevel)
	log the string to the console, and all attached console clients
void	ast_console_toggle_loglevel (int fd, int level, int state)
	enables or disables logging of a specified level to the console
void	ast_console_toggle_mute (int fd, int silent)
	mute or unmute a console from logging
ast_callid	ast_create_callid (void)
	factory function to create a new uniquely identifying callid.
unsigned int	ast_debug_get_by_module (const char *module)
	Get the debug level for a module.
void	ast_init_logger_for_socket_console (void)
	load logger.conf configuration for console socket connections
int	ast_is_logger_initialized (void)
	Test if logger is initialized.
void	ast_log (int level, const char *file, int line, const char *function, const char *fmt,...)
	Used for sending a log message This is the standard logger function. Probably the only way you will invoke it would be something like this: ast_log(AST_LOG_WHATEVER, "Problem with the %s Captain. We should get some more. Will %d be enough?\n", "flux capacitor", 10); where WHATEVER is one of ERROR, DEBUG, EVENT, NOTICE, or WARNING depending on which log you wish to output to. These are implemented as macros, that will provide the function with the needed arguments.
void	ast_log_ap (int level, const char *file, int line, const char *function, const char *fmt, va_list ap)
void	ast_log_backtrace (void)
	Log a backtrace of the current thread's execution stack to the Asterisk log.
void	ast_log_callid (int level, const char *file, int line, const char *function, ast_callid callid, const char *fmt,...)
	Used for sending a log message with a known call_id This is a modified logger function which is functionally identical to the above logger function, it just include a call_id argument as well. If NULL is specified here, no attempt will be made to join the log message with a call_id.
void	ast_log_safe (int level, const char *file, int line, const char *function, const char *fmt,...)
	Used for sending a log message with protection against recursion.
int	ast_logger_create_channel (const char *log_channel, const char *components)
	Create a log channel.
int	ast_logger_get_channels (int(*logentry)(const char *channel, const char *type, const char *status, const char *configuration, void *data), void *data)
	Retrieve the existing log channels.
const char *	ast_logger_get_dateformat (void)
	Get the logger configured date format.
int	ast_logger_get_dynamic_level (const char *name)
	Retrieve dynamic logging level id.
int	ast_logger_get_over_threshold_queue_limit (void)
	Get the over threshold maximum number of messages allowed in the processing queue.
int	ast_logger_get_queue_limit (void)
	Get the maximum number of messages allowed in the processing queue.
int	ast_logger_register_level (const char *name)
	Register a new logger level.
int	ast_logger_remove_channel (const char *log_channel)
	Delete the specified log channel.
int	ast_logger_rotate (void)
	Reload logger while rotating log files.
int	ast_logger_rotate_channel (const char *log_channel)
	Rotate the specified log channel.
void	ast_logger_set_over_threshold_queue_limit (int limit)
	Set the threshold for the maximum number of WARNING/ERROR messages allowed in the processing queue that can exceed the logger queue's threshold. This acts as a buffer for WARNING/ERROR messages so that we can continue to queue them while discarding other message types. This threshold sits on top of the logger queue's message threshold, so the actual queue size will be the logger queue threshold PLUS this threshold.
void	ast_logger_set_queue_limit (int queue_limit)
	Set the maximum number of messages allowed in the processing queue.
void	ast_logger_unregister_level (const char *name)
	Unregister a previously registered logger level.
void	ast_queue_log (const char *queuename, const char *callid, const char *agent, const char *event, const char *fmt,...)
ast_callid	ast_read_threadstorage_callid (void)
	extracts the callid from the thread
unsigned int	ast_trace_get_by_module (const char *module)
	Get the trace level for a module.
int	ast_verb_console_get (void)
	Get this thread's console verbosity level.
void	ast_verb_console_register (int *level)
	Register this thread's console verbosity level pointer.
void	ast_verb_console_set (int verb_level)
	Set this thread's console verbosity level.
void	ast_verb_console_unregister (void)
	Unregister this thread's console verbosity level.
void	ast_verb_update (void)
	Re-evaluate the system max verbosity level (ast_verb_sys_level).

Variables
int	ast_verb_sys_level

Detailed Description

Support for logging to various files, console and syslog Configuration in file logger.conf.

Definition in file include/asterisk/logger.h.

Macro Definition Documentation

__LOG_DEBUG

#define __LOG_DEBUG   0

Definition at line 246 of file include/asterisk/logger.h.

__LOG_DTMF

#define __LOG_DTMF   6

Definition at line 312 of file include/asterisk/logger.h.

__LOG_ERROR

#define __LOG_ERROR   4

Definition at line 290 of file include/asterisk/logger.h.

__LOG_NOTICE

#define __LOG_NOTICE   2

Definition at line 268 of file include/asterisk/logger.h.

__LOG_TRACE

#define __LOG_TRACE   1

Definition at line 257 of file include/asterisk/logger.h.

__LOG_VERBOSE

#define __LOG_VERBOSE   5

Definition at line 301 of file include/asterisk/logger.h.

__LOG_WARNING

#define __LOG_WARNING   3

Definition at line 279 of file include/asterisk/logger.h.

_A_

#define _A_   __FILE__, __LINE__, __FUNCTION__

Definition at line 42 of file include/asterisk/logger.h.

AST_CALLID_BUFFER_LENGTH

#define AST_CALLID_BUFFER_LENGTH   13

Definition at line 55 of file include/asterisk/logger.h.

ast_debug

#define ast_debug	(		level,
			...
	)

Value:

    do { \
        if (DEBUG_ATLEAST(level)) { \
            ast_log(AST_LOG_DEBUG, __VA_ARGS__); \
        } \
    } while (0)

Log a DEBUG message.

Parameters

level

The minimum value of option_debug for this message to get logged

Examples

app_skel.c.

Definition at line 456 of file include/asterisk/logger.h.

       { \
        if (DEBUG_ATLEAST(level)) { \
            ast_log(AST_LOG_DEBUG, __VA_ARGS__); \
        } \
    } while (0)

AST_LOG_DEBUG

#define AST_LOG_DEBUG   __LOG_DEBUG, _A_

Definition at line 252 of file include/asterisk/logger.h.

AST_LOG_DTMF

#define AST_LOG_DTMF   __LOG_DTMF, _A_

Definition at line 318 of file include/asterisk/logger.h.

ast_log_dynamic_level

#define ast_log_dynamic_level	(		level,
			...
	)		ast_log(level, _A_, __VA_ARGS__)

Send a log message to a dynamically registered log level.

Parameters

level

The log level to send the message to

Like ast_log, the log message may include printf-style formats, and the data for these must be provided as additional parameters after the log message.

Since

1.8

Definition at line 443 of file include/asterisk/logger.h.

AST_LOG_ERROR

#define AST_LOG_ERROR   __LOG_ERROR, _A_

Definition at line 296 of file include/asterisk/logger.h.

AST_LOG_NOTICE

#define AST_LOG_NOTICE   __LOG_NOTICE, _A_

Definition at line 274 of file include/asterisk/logger.h.

AST_LOG_TRACE

#define AST_LOG_TRACE   __LOG_TRACE, _A_

Definition at line 263 of file include/asterisk/logger.h.

AST_LOG_VERBOSE

#define AST_LOG_VERBOSE   __LOG_VERBOSE, _A_

Definition at line 307 of file include/asterisk/logger.h.

AST_LOG_WARNING

#define AST_LOG_WARNING   __LOG_WARNING, _A_

Definition at line 285 of file include/asterisk/logger.h.

ast_verb

#define ast_verb	(		level,
			...
	)

Value:

    do { \
        if (VERBOSITY_ATLEAST(level) ) { \
            __ast_verbose(_A_, level, __VA_ARGS__); \
        } \
    } while (0)

Definition at line 467 of file include/asterisk/logger.h.

       { \
        if (VERBOSITY_ATLEAST(level) ) { \
            __ast_verbose(_A_, level, __VA_ARGS__); \
        } \
    } while (0)

ast_verb_callid

#define ast_verb_callid	(		level,
			callid,
			...
	)

Value:

    do { \
        if (VERBOSITY_ATLEAST(level) ) { \
            __ast_verbose_callid(_A_, level, callid, __VA_ARGS__); \
        } \
    } while (0)

Definition at line 474 of file include/asterisk/logger.h.

       { \
        if (VERBOSITY_ATLEAST(level) ) { \
            __ast_verbose_callid(_A_, level, callid, __VA_ARGS__); \
        } \
    } while (0)

ast_verbose

#define ast_verbose

(

...

)

__ast_verbose(_A_, -1, __VA_ARGS__)

Definition at line 188 of file include/asterisk/logger.h.

ast_verbose_callid

#define ast_verbose_callid	(		callid,
			...
	)		__ast_verbose_callid(_A_, -1, callid, __VA_ARGS__)

Definition at line 189 of file include/asterisk/logger.h.

DEBUG_ATLEAST

#define DEBUG_ATLEAST

(

level

)

Value:

    (option_debug >= (level) \
        || (ast_opt_dbg_module \
            && ((int)ast_debug_get_by_module(AST_MODULE) >= (level) \
                || (int)ast_debug_get_by_module(__FILE__) >= (level))))

Definition at line 445 of file include/asterisk/logger.h.

DEBUG_M

#define DEBUG_M

(

a

)

Value:

    { \
    a; \
}

Definition at line 38 of file include/asterisk/logger.h.

                   { \
    a; \
}

EVENTLOG

#define EVENTLOG   "event_log"

Definition at line 35 of file include/asterisk/logger.h.

LOG_DEBUG

#define LOG_DEBUG   __LOG_DEBUG, _A_

Definition at line 247 of file include/asterisk/logger.h.

LOG_DTMF

#define LOG_DTMF   __LOG_DTMF, _A_

Definition at line 313 of file include/asterisk/logger.h.

LOG_ERROR

#define LOG_ERROR   __LOG_ERROR, _A_

Examples

app_skel.c.

Definition at line 291 of file include/asterisk/logger.h.

LOG_NOTICE

#define LOG_NOTICE   __LOG_NOTICE, _A_

Definition at line 269 of file include/asterisk/logger.h.

LOG_TRACE

#define LOG_TRACE   __LOG_TRACE, _A_

Definition at line 258 of file include/asterisk/logger.h.

LOG_VERBOSE

#define LOG_VERBOSE   __LOG_VERBOSE, _A_

Definition at line 302 of file include/asterisk/logger.h.

LOG_WARNING

#define LOG_WARNING   __LOG_WARNING, _A_

Examples

app_skel.c.

Definition at line 280 of file include/asterisk/logger.h.

NUMLOGLEVELS

#define NUMLOGLEVELS   32

Definition at line 320 of file include/asterisk/logger.h.

QUEUELOG

#define QUEUELOG   "queue_log"

Definition at line 36 of file include/asterisk/logger.h.

VERBOSE_HASMAGIC

#define VERBOSE_HASMAGIC

(

x

)

(*(signed char *) (x) < 0)

Definition at line 201 of file include/asterisk/logger.h.

VERBOSE_MAGIC2LEVEL

#define VERBOSE_MAGIC2LEVEL

(

x

)

(((char) -*(signed char *) (x)) - 1)

Definition at line 200 of file include/asterisk/logger.h.

VERBOSE_PREFIX_1

#define VERBOSE_PREFIX_1   " "

Definition at line 44 of file include/asterisk/logger.h.

VERBOSE_PREFIX_10

#define VERBOSE_PREFIX_10   " > "

Definition at line 53 of file include/asterisk/logger.h.

VERBOSE_PREFIX_2

#define VERBOSE_PREFIX_2   " == "

Definition at line 45 of file include/asterisk/logger.h.

VERBOSE_PREFIX_3

#define VERBOSE_PREFIX_3   " -- "

Definition at line 46 of file include/asterisk/logger.h.

VERBOSE_PREFIX_4

#define VERBOSE_PREFIX_4   " > "

Definition at line 47 of file include/asterisk/logger.h.

VERBOSE_PREFIX_5

#define VERBOSE_PREFIX_5   " > "

Definition at line 48 of file include/asterisk/logger.h.

VERBOSE_PREFIX_6

#define VERBOSE_PREFIX_6   " > "

Definition at line 49 of file include/asterisk/logger.h.

VERBOSE_PREFIX_7

#define VERBOSE_PREFIX_7   " > "

Definition at line 50 of file include/asterisk/logger.h.

VERBOSE_PREFIX_8

#define VERBOSE_PREFIX_8   " > "

Definition at line 51 of file include/asterisk/logger.h.

VERBOSE_PREFIX_9

#define VERBOSE_PREFIX_9   " > "

Definition at line 52 of file include/asterisk/logger.h.

VERBOSITY_ATLEAST

#define VERBOSITY_ATLEAST

(

level

)

((level) <= ast_verb_sys_level)

Definition at line 465 of file include/asterisk/logger.h.

Typedef Documentation

ast_callid

typedef unsigned int ast_callid

Definition at line 96 of file include/asterisk/logger.h.

Enumeration Type Documentation

ast_logger_results

enum ast_logger_results

Enumerator
AST_LOGGER_SUCCESS	Log channel was created or deleted successfully
AST_LOGGER_FAILURE	Log channel already exists for create or doesn't exist for deletion of log channel
AST_LOGGER_DECLINE	Log channel request was not accepted
AST_LOGGER_ALLOC_ERROR	filename allocation error

Definition at line 57 of file include/asterisk/logger.h.

                        {
    AST_LOGGER_SUCCESS = 0, /*!< Log channel was created or deleted successfully */
    AST_LOGGER_FAILURE = 1, /*!< Log channel already exists for create or doesn't exist for deletion of log channel */
    AST_LOGGER_DECLINE = -1, /*!< Log channel request was not accepted */
    AST_LOGGER_ALLOC_ERROR = -2 /*!< filename allocation error */
};

Function Documentation

__ast_verbose()

void __ast_verbose	(	const char *	file,
		int	line,
		const char *	func,
		int	level,
		const char *	fmt,
			...
	)

Send a verbose message (based on verbose level)

This works like ast_log, but prints verbose messages to the console depending on verbosity level set.

ast_verbose(VERBOSE_PREFIX_3 "Whatever %s is happening\n", "nothing");

This will print the message to the console if the verbose level is set to a level >= 3

Note the absence of a comma after the VERBOSE_PREFIX_3. This is important. VERBOSE_PREFIX_1 through VERBOSE_PREFIX_10 are defined.

Version

11 added level parameter

Definition at line 2617 of file logger.c.

{
    ast_callid callid;
    va_list ap;
 
    callid = ast_read_threadstorage_callid();
 
    va_start(ap, fmt);
    __ast_verbose_ap(file, line, func, level, callid, fmt, ap);
    va_end(ap);
}

References __ast_verbose_ap(), and ast_read_threadstorage_callid().

__ast_verbose_ap()

void __ast_verbose_ap	(	const char *	file,
		int	line,
		const char *	func,
		int	level,
		ast_callid	callid,
		const char *	fmt,
		va_list	ap
	)

Definition at line 2612 of file logger.c.

{
    ast_log_full(__LOG_VERBOSE, level, file, line, func, callid, fmt, ap);
}

References __LOG_VERBOSE, and ast_log_full().

Referenced by __ast_verbose(), __ast_verbose_callid(), and ast_log_ap().

__ast_verbose_callid()

void __ast_verbose_callid	(	const char *	file,
		int	line,
		const char *	func,
		int	level,
		ast_callid	callid,
		const char *	fmt,
			...
	)

Send a verbose message (based on verbose level) with deliberately specified callid.

just like __ast_verbose, only __ast_verbose_callid allows you to specify which callid is being used for the log without needing to bind it to a thread. NULL is a valid argument for this function and will allow you to specify that a log will never display a call id even when there is a call id bound to the thread.

Definition at line 2629 of file logger.c.

{
    va_list ap;
    va_start(ap, fmt);
    __ast_verbose_ap(file, line, func, level, callid, fmt, ap);
    va_end(ap);
}

References __ast_verbose_ap().

ast_callid_strnprint()

void ast_callid_strnprint	(	char *	buffer,
		size_t	buffer_size,
		ast_callid	callid
	)

copy a string representation of the callid into a target string

Parameters

buffer	destination of callid string (should be able to store 13 characters or more)
buffer_size	maximum writable length of the string (Less than 13 will result in truncation)
callid	Callid for which string is being requested

Definition at line 2277 of file logger.c.

{
    snprintf(buffer, buffer_size, "[C-%08x]", callid);
}

Referenced by ast_channel_callid_set(), func_channel_read(), handle_showchan(), and iax_pvt_callid_new().

ast_callid_threadassoc_add()

int ast_callid_threadassoc_add

(

ast_callid

callid

)

Adds a known callid to thread storage of the calling thread.

Return values

0	- success
non-zero	- failure

Definition at line 2309 of file logger.c.

{
    ast_callid *pointing;
 
    pointing = ast_threadstorage_get(&unique_callid, sizeof(*pointing));
    if (!pointing) {
        return -1;
    }
 
    if (*pointing) {
        ast_log(LOG_ERROR, "ast_callid_threadassoc_add(C-%08x) on thread "
            "already associated with callid [C-%08x].\n", callid, *pointing);
        return 1;
    }
 
    *pointing = callid;
    return 0;
}

References ast_log, ast_threadstorage_get(), and LOG_ERROR.

Referenced by __analog_ss_thread(), __ast_pbx_run(), ast_callid_threadstorage_auto(), async_dial(), attended_transfer_monitor_thread(), bridge_channel_control_thread(), bridge_channel_depart_thread(), bridge_channel_ind_thread(), jingle_action_hook(), jingle_outgoing_hook(), mixmonitor_thread(), socket_process_helper(), and softmix_mixing_thread().

ast_callid_threadassoc_change()

int ast_callid_threadassoc_change

(

ast_callid

callid

)

Sets what is stored in the thread storage to the given callid if it does not match what is already there.

Return values

0	- success
non-zero	- failure

Definition at line 2296 of file logger.c.

{
    ast_callid *id = ast_threadstorage_get(&unique_callid, sizeof(*id));
 
    if (!id) {
        return -1;
    }
 
    *id = callid;
 
    return 0;
}

References ast_threadstorage_get().

Referenced by autoservice_run(), and bridge_manager_service().

ast_callid_threadassoc_remove()

int ast_callid_threadassoc_remove

(

void

)

Removes callid from thread storage of the calling thread.

Return values

0	- success
non-zero	- failure

Definition at line 2328 of file logger.c.

{
    ast_callid *pointing;
 
    pointing = ast_threadstorage_get(&unique_callid, sizeof(*pointing));
    if (!pointing) {
        return -1;
    }
 
    if (*pointing) {
        *pointing = 0;
        return 0;
    }
 
    return -1;
}

References ast_threadstorage_get().

Referenced by ast_callid_threadstorage_auto_clean(), attended_transfer_monitor_thread(), jingle_action_hook(), jingle_outgoing_hook(), and socket_process().

ast_callid_threadstorage_auto()

int ast_callid_threadstorage_auto

(

ast_callid *

callid

)

Checks thread storage for a callid and stores a reference if it exists. If not, then a new one will be created, bound to the thread, and a reference to it will be stored.

Parameters

callid

pointer to store the callid

Return values

0	- callid was found
1	- callid was created
-1	- the function failed somehow (presumably memory problems)

Definition at line 2345 of file logger.c.

{
    ast_callid tmp;
 
    /* Start by trying to see if a callid is available from thread storage */
    tmp = ast_read_threadstorage_callid();
    if (tmp) {
        *callid = tmp;
        return 0;
    }
 
    /* If that failed, try to create a new one and bind it. */
    *callid = ast_create_callid();
    if (*callid) {
        ast_callid_threadassoc_add(*callid);
        return 1;
    }
 
    /* If neither worked, then something must have gone wrong. */
    return -1;
}

References ast_callid_threadassoc_add(), ast_create_callid(), and ast_read_threadstorage_callid().

Referenced by __analog_handle_event(), analog_handle_init_event(), dahdi_handle_event(), dahdi_request(), do_monitor(), handle_init_event(), mwi_thread(), and my_new_analog_ast_channel().

ast_callid_threadstorage_auto_clean()

void ast_callid_threadstorage_auto_clean	(	ast_callid	callid,
		int	callid_created
	)

Use in conjunction with ast_callid_threadstorage_auto. Cleans up the references and if the callid was created by threadstorage_auto, unbinds the callid from the threadstorage.

Parameters

callid	The callid set by ast_callid_threadstorage_auto
callid_created	The integer returned through ast_callid_threadstorage_auto

Definition at line 2367 of file logger.c.

{
    if (callid && callid_created) {
        /* If the callid was created rather than simply grabbed from the thread storage, we need to unbind here. */
        ast_callid_threadassoc_remove();
    }
}

References ast_callid_threadassoc_remove().

Referenced by __analog_handle_event(), analog_handle_init_event(), dahdi_handle_event(), dahdi_new_callid_clean(), dahdi_request(), do_monitor(), handle_init_event(), and mwi_thread().

ast_child_verbose()

void ast_child_verbose	(	int	level,
		const char *	fmt,
			...
	)

Definition at line 929 of file logger.c.

{
    char *msg = NULL, *emsg = NULL, *sptr, *eptr;
    va_list ap, aq;
    int size;
 
    va_start(ap, fmt);
    va_copy(aq, ap);
    if ((size = vsnprintf(msg, 0, fmt, ap)) < 0) {
        va_end(ap);
        va_end(aq);
        return;
    }
    va_end(ap);
 
    if (!(msg = ast_malloc(size + 1))) {
        va_end(aq);
        return;
    }
 
    vsnprintf(msg, size + 1, fmt, aq);
    va_end(aq);
 
    if (!(emsg = ast_malloc(size * 2 + 1))) {
        ast_free(msg);
        return;
    }
 
    for (sptr = msg, eptr = emsg; ; sptr++) {
        if (*sptr == '"') {
            *eptr++ = '\\';
        }
        *eptr++ = *sptr;
        if (*sptr == '\0') {
            break;
        }
    }
    ast_free(msg);
 
    fprintf(stdout, "verbose \"%s\" %d\n", emsg, level);
    fflush(stdout);
    ast_free(emsg);
}

References ast_free, ast_malloc, and NULL.

Referenced by launch_script().

ast_console_puts()

void ast_console_puts

(

const char *

string

)

write the string to the root console, and all attached network console clients

Definition at line 1369 of file asterisk.c.

{
    /* Send to the root console */
    fputs(string, stdout);
    fflush(stdout);
 
    /* Send to any network console clients */
    ast_network_puts(string);
}

References ast_network_puts().

ast_console_puts_mutable()

void ast_console_puts_mutable	(	const char *	string,
		int	level
	)

log the string to the console, and all attached console clients

Parameters

string	The message to write to the console
level	The log level of the message

Version

1.6.1 added level parameter

log the string to the console, and all attached console clients

Definition at line 1329 of file asterisk.c.

{
    ast_console_puts_mutable_full(string, level, 0);
}

References ast_console_puts_mutable_full().

Referenced by init_logger_chain(), and make_logchannel().

ast_console_puts_mutable_full()

void ast_console_puts_mutable_full	(	const char *	message,
		int	level,
		int	sublevel
	)

log the string to the console, and all attached console clients

Since

14.0.0

Parameters

message	The message to write to the console
sublevel	If the log level supports it, the sub-level of the message
level	The log level of the message

Definition at line 1336 of file asterisk.c.

{
    /* Send to the root console */
    console_print(message);
 
    /* Wake up a poll()ing console */
    if (ast_opt_console && consolethread != AST_PTHREADT_NULL) {
        pthread_kill(consolethread, SIGURG);
    }
 
    /* Send to any network console clients */
    ast_network_puts_mutable(message, level, sublevel);
}

References ast_network_puts_mutable(), ast_opt_console, AST_PTHREADT_NULL, console_print(), and consolethread.

Referenced by ast_console_puts_mutable(), and logger_print_normal().

ast_console_toggle_loglevel()

void ast_console_toggle_loglevel	(	int	fd,
		int	level,
		int	state
	)

enables or disables logging of a specified level to the console

Parameters

fd	specifies the index of the console receiving the level change
level	specifies the index of the logging level being toggled
state	indicates whether logging will be on or off (0 for off, 1 for on)

enables or disables logging of a specified level to the console

Definition at line 1264 of file asterisk.c.

{
    int x;
 
    if (level >= NUMLOGLEVELS) {
        level = NUMLOGLEVELS - 1;
    }
 
    for (x = 0;x < AST_MAX_CONNECTS; x++) {
        if (fd == consoles[x].fd) {
            /*
             * Since the logging occurs when levels are false, set to
             * flipped iinput because this function accepts 0 as off and 1 as on
             */
            consoles[x].levels[level] = state ? 0 : 1;
            return;
        }
    }
}

References AST_MAX_CONNECTS, consoles, console::levels, and NUMLOGLEVELS.

Referenced by handle_logger_set_level().

ast_console_toggle_mute()

void ast_console_toggle_mute	(	int	fd,
		int	silent
	)

mute or unmute a console from logging

Definition at line 1287 of file asterisk.c.

{
    int x;
    for (x = 0;x < AST_MAX_CONNECTS; x++) {
        if (fd == consoles[x].fd) {
            if (consoles[x].mute) {
                consoles[x].mute = 0;
                if (!silent)
                    ast_cli(fd, "Console is not muted anymore.\n");
            } else {
                consoles[x].mute = 1;
                if (!silent)
                    ast_cli(fd, "Console is muted.\n");
            }
            return;
        }
    }
    ast_cli(fd, "Couldn't find remote console.\n");
}

References ast_cli(), AST_MAX_CONNECTS, consoles, and console::mute.

Referenced by handle_logger_mute().

ast_create_callid()

ast_callid ast_create_callid

(

void

)

factory function to create a new uniquely identifying callid.

Returns

The call id

Definition at line 2282 of file logger.c.

{
    return ast_atomic_fetchadd_int(&next_unique_callid, +1);
}

References ast_atomic_fetchadd_int(), and next_unique_callid.

Referenced by __ast_pbx_run(), ast_callid_threadstorage_auto(), iax_pvt_callid_new(), and jingle_alloc().

ast_debug_get_by_module()

unsigned int ast_debug_get_by_module

(

const char *

module

)

Get the debug level for a module.

Parameters

module

the name of module

Returns

the debug level

Definition at line 139 of file main/cli.c.

{
    struct module_level *ml;
    unsigned int res = 0;
 
    AST_RWLIST_RDLOCK(&debug_modules);
    AST_LIST_TRAVERSE(&debug_modules, ml, entry) {
        if (!strcasecmp(ml->module, module)) {
            res = ml->level;
            break;
        }
    }
    AST_RWLIST_UNLOCK(&debug_modules);
 
    return res;
}

References AST_LIST_TRAVERSE, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, debug_modules, module_level::entry, module_level::level, and module_level::module.

ast_is_logger_initialized()

int ast_is_logger_initialized

(

void

)

Test if logger is initialized.

Return values

true	if the logger is initialized

Definition at line 2164 of file logger.c.

{
    return logger_initialized;
}

References logger_initialized.

Referenced by check_init().

ast_log()

static void ast_log	(	int	level,
		const char *	file,
		int	line,
		const char *	function,
		const char *	fmt,
			...
	)

Used for sending a log message This is the standard logger function. Probably the only way you will invoke it would be something like this: ast_log(AST_LOG_WHATEVER, "Problem with the %s Captain. We should get some more. Will %d be enough?\n", "flux capacitor", 10); where WHATEVER is one of ERROR, DEBUG, EVENT, NOTICE, or WARNING depending on which log you wish to output to. These are implemented as macros, that will provide the function with the needed arguments.

Parameters

level	Type of log event
file	Will be provided by the AST_LOG_* macro
line	Will be provided by the AST_LOG_* macro
function	Will be provided by the AST_LOG_* macro
fmt	This is what is important. The format is the same as your favorite breed of printf. You know how that works, right? :-)

Definition at line 130 of file ael_main.c.

{
            va_list vars;
                va_start(vars,fmt);
 
                    printf("LOG: lev:%d file:%s  line:%d func: %s  ",
                                           level, file, line, function);
                        vprintf(fmt, vars);
                            fflush(stdout);
                                va_end(vars);
}

References ast_log_ap(), logmsg::file, logmsg::function, logmsg::level, and logmsg::line.

ast_log_ap()

void ast_log_ap	(	int	level,
		const char *	file,
		int	line,
		const char *	function,
		const char *	fmt,
		va_list	ap
	)

Definition at line 2529 of file logger.c.

{
    ast_callid callid;
 
    callid = ast_read_threadstorage_callid();
 
    if (level == __LOG_VERBOSE) {
        __ast_verbose_ap(file, line, function, 0, callid, fmt, ap);
    } else {
        ast_log_full(level, -1, file, line, function, callid, fmt, ap);
    }
}

References __ast_verbose_ap(), __LOG_VERBOSE, ast_log_full(), ast_read_threadstorage_callid(), logmsg::callid, logmsg::file, logmsg::function, logmsg::level, and logmsg::line.

Referenced by ast_log(), and module_load_error().

ast_log_backtrace()

void ast_log_backtrace

(

void

)

Log a backtrace of the current thread's execution stack to the Asterisk log.

Definition at line 2577 of file logger.c.

{
#ifdef HAVE_BKTR
    struct ast_bt *bt;
    int i = 0;
    struct ast_vector_string *strings;
 
    if (!(bt = ast_bt_create())) {
        ast_log(LOG_WARNING, "Unable to allocate space for backtrace structure\n");
        return;
    }
 
    if ((strings = ast_bt_get_symbols(bt->addresses, bt->num_frames))) {
        int count = AST_VECTOR_SIZE(strings);
        struct ast_str *buf = ast_str_create(bt->num_frames * 64);
 
        if (buf) {
            ast_str_append(&buf, 0, "Got %d backtrace record%c\n", count - 3, count - 3 != 1 ? 's' : ' ');
            for (i = 3; i < AST_VECTOR_SIZE(strings); i++) {
                ast_str_append(&buf, 0, "#%2d: %s\n", i - 3, AST_VECTOR_GET(strings, i));
            }
            ast_log_safe(__LOG_ERROR, NULL, 0, NULL, "%s\n", ast_str_buffer(buf));
            ast_free(buf);
        }
 
        ast_bt_free_symbols(strings);
    } else {
        ast_log(LOG_ERROR, "Could not allocate memory for backtrace\n");
    }
    ast_bt_destroy(bt);
#else
    ast_log(LOG_WARNING, "Must run configure with '--with-execinfo' for stack backtraces.\n");
#endif /* defined(HAVE_BKTR) */
}

References __LOG_ERROR, ast_bt::addresses, ast_bt_create, ast_bt_destroy, ast_bt_free_symbols, ast_bt_get_symbols, ast_free, ast_log, ast_log_safe(), ast_str_append(), ast_str_buffer(), ast_str_create, AST_VECTOR_GET, AST_VECTOR_SIZE, buf, LOG_ERROR, LOG_WARNING, NULL, and ast_bt::num_frames.

Referenced by __ast_assert_failed(), ast_json_vpack(), ast_sched_del_nonrunning(), and AST_TEST_DEFINE().

ast_log_callid()

void ast_log_callid	(	int	level,
		const char *	file,
		int	line,
		const char *	function,
		ast_callid	callid,
		const char *	fmt,
			...
	)

Used for sending a log message with a known call_id This is a modified logger function which is functionally identical to the above logger function, it just include a call_id argument as well. If NULL is specified here, no attempt will be made to join the log message with a call_id.

Parameters

level	Type of log event
file	Will be provided by the AST_LOG_* macro
line	Will be provided by the AST_LOG_* macro
function	Will be provided by the AST_LOG_* macro
callid	This is the ast_callid that is associated with the log message. May be NULL.
fmt	This is what is important. The format is the same as your favorite breed of printf. You know how that works, right? :-)

Definition at line 2568 of file logger.c.

{
    va_list ap;
    va_start(ap, fmt);
    ast_log_full(level, -1, file, line, function, callid, fmt, ap);
    va_end(ap);
}

References ast_log_full(), logmsg::callid, logmsg::file, logmsg::function, logmsg::level, and logmsg::line.

Referenced by ast_channel_destructor().

ast_log_safe()

void ast_log_safe	(	int	level,
		const char *	file,
		int	line,
		const char *	function,
		const char *	fmt,
			...
	)

Used for sending a log message with protection against recursion.

Note

This function should be used by all error messages that might be directly or indirectly caused by logging.

See also

ast_log for documentation on the parameters.

Definition at line 2542 of file logger.c.

{
    va_list ap;
    void *recursed = ast_threadstorage_get_ptr(&in_safe_log);
    ast_callid callid;
 
    if (recursed) {
        return;
    }
 
    if (ast_threadstorage_set_ptr(&in_safe_log, &(int) { 1 })) {
        /* We've failed to set the flag that protects against
         * recursion, so bail. */
        return;
    }
 
    callid = ast_read_threadstorage_callid();
 
    va_start(ap, fmt);
    ast_log_full(level, -1, file, line, function, callid, fmt, ap);
    va_end(ap);
 
    /* Clear flag so the next allocation failure can be logged. */
    ast_threadstorage_set_ptr(&in_safe_log, NULL);
}

References ast_log_full(), ast_read_threadstorage_callid(), ast_threadstorage_get_ptr(), ast_threadstorage_set_ptr(), logmsg::callid, logmsg::file, logmsg::function, logmsg::level, logmsg::line, and NULL.

Referenced by __ast_str_helper(), and ast_log_backtrace().

ast_logger_create_channel()

int ast_logger_create_channel	(	const char *	log_channel,
		const char *	components
	)

Create a log channel.

Parameters

log_channel	Log channel to create
components	Logging config levels to add to the log channel

Definition at line 1517 of file logger.c.

{
    struct logchannel *chan;
 
    if (ast_strlen_zero(components)) {
        return AST_LOGGER_DECLINE;
    }
 
    AST_RWLIST_WRLOCK(&logchannels);
 
    chan = find_logchannel(log_channel);
    if (chan) {
        AST_RWLIST_UNLOCK(&logchannels);
        return AST_LOGGER_FAILURE;
    }
 
    chan = make_logchannel(log_channel, components, 0, 1);
    if (!chan) {
        AST_RWLIST_UNLOCK(&logchannels);
        return AST_LOGGER_ALLOC_ERROR;
    }
 
    AST_RWLIST_INSERT_HEAD(&logchannels, chan, list);
    global_logmask |= chan->logmask;
 
    AST_RWLIST_UNLOCK(&logchannels);
 
    return AST_LOGGER_SUCCESS;
}

References AST_LOGGER_ALLOC_ERROR, AST_LOGGER_DECLINE, AST_LOGGER_FAILURE, AST_LOGGER_SUCCESS, AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_strlen_zero(), logchannel::components, find_logchannel(), global_logmask, logchannel::list, logchannel::logmask, and make_logchannel().

Referenced by ast_ari_asterisk_add_log(), handle_cli_queue_over_threshold_test(), handle_cli_queue_test(), and handle_logger_add_channel().

ast_logger_get_channels()

int ast_logger_get_channels	(	int(*)(const char *channel, const char *type, const char *status, const char *configuration, void *data)	logentry,
		void *	data
	)

Retrieve the existing log channels.

Parameters

logentry	A callback to an updater function
data	Data passed into the callback for manipulation

For each of the logging channels, logentry will be executed with the channel file name, log type, status of the log, and configuration levels.

Return values

0	on success
1	on failure
-2	on allocation error

Definition at line 1405 of file logger.c.

{
    struct logchannel *chan;
    struct ast_str *configs = ast_str_create(64);
    int res = AST_LOGGER_SUCCESS;
 
    if (!configs) {
        return AST_LOGGER_ALLOC_ERROR;
    }
 
    AST_RWLIST_RDLOCK(&logchannels);
    AST_RWLIST_TRAVERSE(&logchannels, chan, list) {
        unsigned int level;
 
        ast_str_reset(configs);
 
        for (level = 0; level < ARRAY_LEN(levels); level++) {
            if ((chan->logmask & (1 << level)) && levels[level]) {
                ast_str_append(&configs, 0, "%s ", levels[level]);
            }
        }
 
        res = logentry(chan->filename, chan->type == LOGTYPE_CONSOLE ? "Console" :
            (chan->type == LOGTYPE_SYSLOG ? "Syslog" : "File"), chan->disabled ?
            "Disabled" : "Enabled", ast_str_buffer(configs), data);
 
        if (res) {
            AST_RWLIST_UNLOCK(&logchannels);
            ast_free(configs);
            configs = NULL;
            return AST_LOGGER_FAILURE;
        }
    }
    AST_RWLIST_UNLOCK(&logchannels);
 
    ast_free(configs);
    configs = NULL;
 
    return AST_LOGGER_SUCCESS;
}

References ARRAY_LEN, ast_free, AST_LOGGER_ALLOC_ERROR, AST_LOGGER_FAILURE, AST_LOGGER_SUCCESS, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_str_append(), ast_str_buffer(), ast_str_create, ast_str_reset(), logchannel::disabled, logchannel::filename, levels, logchannel::logmask, LOGTYPE_CONSOLE, LOGTYPE_SYSLOG, NULL, and logchannel::type.

Referenced by ast_ari_asterisk_list_log_channels().

ast_logger_get_dateformat()

const char * ast_logger_get_dateformat

(

void

)

Get the logger configured date format.

Returns

The date format string

Since

13.0.0

Definition at line 2994 of file logger.c.

{
    return dateformat;
}

References dateformat.

Referenced by set_header().

ast_logger_get_dynamic_level()

int ast_logger_get_dynamic_level

(

const char *

name

)

Retrieve dynamic logging level id.

Parameters

name	The name of the level

Returns

The unique integer id for the given level

Return values

-1	if level name not found

Definition at line 2947 of file logger.c.

{
    int level = -1;
 
    AST_RWLIST_RDLOCK(&logchannels);
 
    level = logger_get_dynamic_level(name);
 
    AST_RWLIST_UNLOCK(&logchannels);
 
    return level;
}

References AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, logger_get_dynamic_level(), and name.

Referenced by log_exec().

ast_logger_get_over_threshold_queue_limit()

int ast_logger_get_over_threshold_queue_limit

(

void

)

Get the over threshold maximum number of messages allowed in the processing queue.

Returns

Over threshold queue limit

Definition at line 3014 of file logger.c.

{
    return logger_queue_over_threshold_limit;
}

References logger_queue_over_threshold_limit.

Referenced by handle_cli_queue_over_threshold_test().

ast_logger_get_queue_limit()

int ast_logger_get_queue_limit

(

void

)

Get the maximum number of messages allowed in the processing queue.

Returns

Queue limit

Definition at line 3004 of file logger.c.

{
    return logger_queue_limit;
}

References logger_queue_limit.

Referenced by handle_cli_queue_over_threshold_test(), and handle_cli_queue_test().

ast_logger_register_level()

int ast_logger_register_level

(

const char *

name

)

Register a new logger level.

Parameters

name	The name of the level to be registered

Return values

-1	if an error occurs
non-zero	level to be used with ast_log for sending messages to this level

Since

1.8

Definition at line 2918 of file logger.c.

{
    int available = 0;
 
    AST_RWLIST_WRLOCK(&logchannels);
    available = logger_register_level(name);
    AST_RWLIST_UNLOCK(&logchannels);
 
    return available;
}

References AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, available(), logger_register_level(), and name.

Referenced by handle_cli_dynamic_level_test(), handle_cli_performance_test(), handle_cli_queue_over_threshold_test(), handle_cli_queue_test(), load_module(), load_module(), load_module(), and load_module().

ast_logger_remove_channel()

int ast_logger_remove_channel

(

const char *

log_channel

)

Delete the specified log channel.

Parameters

log_channel

The log channel to delete

Definition at line 1583 of file logger.c.

{
    struct logchannel *chan;
 
    AST_RWLIST_WRLOCK(&logchannels);
 
    chan = find_logchannel(log_channel);
    if (chan && chan->dynamic) {
        AST_RWLIST_REMOVE(&logchannels, chan, list);
    } else {
        AST_RWLIST_UNLOCK(&logchannels);
        return AST_LOGGER_FAILURE;
    }
    AST_RWLIST_UNLOCK(&logchannels);
 
    if (chan->fileptr) {
        fclose(chan->fileptr);
        chan->fileptr = NULL;
    }
    ast_free(chan);
    chan = NULL;
 
    return AST_LOGGER_SUCCESS;
}

References ast_free, AST_LOGGER_FAILURE, AST_LOGGER_SUCCESS, AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, logchannel::dynamic, logchannel::fileptr, find_logchannel(), logchannel::list, and NULL.

Referenced by ast_ari_asterisk_delete_log(), handle_cli_queue_over_threshold_test(), handle_cli_queue_test(), and handle_logger_remove_channel().

ast_logger_rotate()

int ast_logger_rotate

(

void

)

Reload logger while rotating log files.

Definition at line 1323 of file logger.c.

{
    return reload_logger(1, NULL);
}

References NULL, and reload_logger().

Referenced by action_loggerrotate().

ast_logger_rotate_channel()

int ast_logger_rotate_channel

(

const char *

log_channel

)

Rotate the specified log channel.

Parameters

log_channel

The log channel to rotate

Definition at line 1328 of file logger.c.

{
    struct logchannel *f;
    int success = AST_LOGGER_FAILURE;
    char filename[PATH_MAX];
 
    make_filename(log_channel, filename, sizeof(filename));
 
    AST_RWLIST_WRLOCK(&logchannels);
 
    ast_mkdir(ast_config_AST_LOG_DIR, 0644);
 
    AST_RWLIST_TRAVERSE(&logchannels, f, list) {
        if (f->disabled) {
            f->disabled = 0;    /* Re-enable logging at reload */
            manager_event(EVENT_FLAG_SYSTEM, "LogChannel", "Channel: %s\r\nEnabled: Yes\r\n",
                f->filename);
        }
        if (f->fileptr && (f->fileptr != stdout) && (f->fileptr != stderr)) {
            fclose(f->fileptr); /* Close file */
            f->fileptr = NULL;
            if (strcmp(filename, f->filename) == 0) {
                rotate_file(f->filename);
                success = AST_LOGGER_SUCCESS;
            }
        }
    }
 
    init_logger_chain(NULL);
 
    AST_RWLIST_UNLOCK(&logchannels);
 
    return success;
}

References ast_config_AST_LOG_DIR, AST_LOGGER_FAILURE, AST_LOGGER_SUCCESS, ast_mkdir(), AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, logchannel::disabled, EVENT_FLAG_SYSTEM, logchannel::filename, logchannel::fileptr, init_logger_chain(), logchannel::list, make_filename(), manager_event, NULL, PATH_MAX, and rotate_file().

Referenced by ast_ari_asterisk_rotate_log().

ast_logger_set_over_threshold_queue_limit()

void ast_logger_set_over_threshold_queue_limit

(

int

limit

)

Set the threshold for the maximum number of WARNING/ERROR messages allowed in the processing queue that can exceed the logger queue's threshold. This acts as a buffer for WARNING/ERROR messages so that we can continue to queue them while discarding other message types. This threshold sits on top of the logger queue's message threshold, so the actual queue size will be the logger queue threshold PLUS this threshold.

Parameters

limit

Definition at line 3009 of file logger.c.

{
    logger_queue_over_threshold_limit = limit;
}

References logger_queue_over_threshold_limit.

Referenced by handle_cli_queue_over_threshold_test().

ast_logger_set_queue_limit()

void ast_logger_set_queue_limit

(

int

queue_limit

)

Set the maximum number of messages allowed in the processing queue.

Parameters

queue_limit

Definition at line 2999 of file logger.c.

{
    logger_queue_limit = queue_limit;
}

References logger_queue_limit.

Referenced by handle_cli_queue_over_threshold_test(), and handle_cli_queue_test().

ast_logger_unregister_level()

void ast_logger_unregister_level

(

const char *

name

)

Unregister a previously registered logger level.

Parameters

name	The name of the level to be unregistered

Since

1.8

Definition at line 2976 of file logger.c.

{
    int x;
 
    AST_RWLIST_WRLOCK(&logchannels);
    x = logger_unregister_level(name);
 
    if (x) {
        update_logchannels();
    }
 
    AST_RWLIST_UNLOCK(&logchannels);
 
    if (x) {
        ast_debug(1, "Unregistered dynamic logger level '%s' with index %u.\n", name, x);
    }
}

References ast_debug, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, logger_unregister_level(), name, and update_logchannels().

Referenced by handle_cli_dynamic_level_test(), handle_cli_performance_test(), handle_cli_queue_over_threshold_test(), handle_cli_queue_test(), load_module(), unload_module(), unload_module(), unload_module(), and unload_module().

ast_queue_log()

void ast_queue_log	(	const char *	queuename,
		const char *	callid,
		const char *	agent,
		const char *	event,
		const char *	fmt,
			...
	)

Definition at line 973 of file logger.c.

{
    va_list ap;
    struct timeval tv;
    struct ast_tm tm;
    char qlog_msg[8192];
    int qlog_len;
    char time_str[30];
 
    if (!logger_initialized) {
        /* You are too early.  We are not open yet! */
        return;
    }
    if (!queuelog_init) {
        /* We must initialize now since someone is trying to log something. */
        logger_queue_start();
    }
 
    if (ast_check_realtime("queue_log")) {
        tv = ast_tvnow();
        ast_localtime(&tv, &tm, logfiles.queue_log_realtime_use_gmt ? "GMT" : NULL);
        ast_strftime(time_str, sizeof(time_str), "%F %T.%6q", &tm);
        va_start(ap, fmt);
        vsnprintf(qlog_msg, sizeof(qlog_msg), fmt, ap);
        va_end(ap);
        if (logfiles.queue_adaptive_realtime) {
            AST_DECLARE_APP_ARGS(args,
                AST_APP_ARG(data)[5];
            );
            AST_NONSTANDARD_APP_ARGS(args, qlog_msg, '|');
            /* Ensure fields are large enough to receive data */
            ast_realtime_require_field("queue_log",
                "data1", RQ_CHAR, strlen(S_OR(args.data[0], "")),
                "data2", RQ_CHAR, strlen(S_OR(args.data[1], "")),
                "data3", RQ_CHAR, strlen(S_OR(args.data[2], "")),
                "data4", RQ_CHAR, strlen(S_OR(args.data[3], "")),
                "data5", RQ_CHAR, strlen(S_OR(args.data[4], "")),
                SENTINEL);
 
            /* Store the log */
            ast_store_realtime("queue_log", "time", time_str,
                "callid", callid,
                "queuename", queuename,
                "agent", agent,
                "event", event,
                "data1", S_OR(args.data[0], ""),
                "data2", S_OR(args.data[1], ""),
                "data3", S_OR(args.data[2], ""),
                "data4", S_OR(args.data[3], ""),
                "data5", S_OR(args.data[4], ""),
                SENTINEL);
        } else {
            ast_store_realtime("queue_log", "time", time_str,
                "callid", callid,
                "queuename", queuename,
                "agent", agent,
                "event", event,
                "data", qlog_msg,
                SENTINEL);
        }
 
        if (!logfiles.queue_log_to_file) {
            return;
        }
    }
 
    if (qlog) {
        va_start(ap, fmt);
        qlog_len = snprintf(qlog_msg, sizeof(qlog_msg), "%ld|%s|%s|%s|%s|", (long)time(NULL), callid, queuename, agent, event);
        vsnprintf(qlog_msg + qlog_len, sizeof(qlog_msg) - qlog_len, fmt, ap);
        va_end(ap);
        AST_RWLIST_RDLOCK(&logchannels);
        if (qlog) {
            fprintf(qlog, "%s\n", qlog_msg);
            fflush(qlog);
        }
        AST_RWLIST_UNLOCK(&logchannels);
    }
}

References args, AST_APP_ARG, ast_check_realtime(), AST_DECLARE_APP_ARGS, ast_localtime(), AST_NONSTANDARD_APP_ARGS, ast_realtime_require_field(), AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_store_realtime(), ast_strftime(), ast_tvnow(), logfiles, logger_initialized, logger_queue_start(), NULL, qlog, queuelog_init, RQ_CHAR, S_OR, and SENTINEL.

Referenced by aqm_exec(), find_queue_by_name_rt(), handle_blind_transfer(), handle_hangup(), handle_queue_add_member(), handle_queue_remove_member(), log_attended_transfer(), manager_add_queue_member(), manager_queue_log_custom(), manager_remove_queue_member(), ql_exec(), queue_agent_cb(), queue_exec(), qupd_exec(), rna(), rqm_exec(), rt_handle_member_record(), set_member_paused(), set_member_penalty_help_members(), set_queue_member_pause(), set_queue_member_ringinuse(), try_calling(), update_realtime_members(), wait_for_answer(), and wait_our_turn().

ast_read_threadstorage_callid()

ast_callid ast_read_threadstorage_callid

(

void

)

extracts the callid from the thread

Return values

Non-zero	Call id related to the thread
0	if no call_id is present in the thread

Definition at line 2287 of file logger.c.

{
    ast_callid *callid;
 
    callid = ast_threadstorage_get(&unique_callid, sizeof(*callid));
 
    return callid ? *callid : 0;
}

References ast_threadstorage_get().

Referenced by __ast_pbx_run(), __ast_verbose(), ast_callid_threadstorage_auto(), ast_dial_run(), ast_log_ap(), ast_log_safe(), bridge_channel_internal_join(), bridge_impart_internal(), callid_set_chanloggroup(), common_recall_channel_setup(), iax2_request(), jingle_alloc(), launch_monitor_thread(), local_request_with_stream_topology(), media_request_helper(), and socket_process().

ast_verb_console_get()

int ast_verb_console_get

(

void

)

Get this thread's console verbosity level.

Returns

verbosity level of the console.

Definition at line 2740 of file logger.c.

{
    struct verb_console *console;
    int verb_level;
 
    console = ast_threadstorage_get(&my_verb_console, sizeof(*console));
    AST_RWLIST_RDLOCK(&verb_consoles);
    if (!console) {
        verb_level = 0;
    } else if (console->level) {
        verb_level = *console->level;
    } else {
        verb_level = option_verbose;
    }
    AST_RWLIST_UNLOCK(&verb_consoles);
    return verb_level;
}

References AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_threadstorage_get(), and option_verbose.

Referenced by handle_show_settings(), and handle_verbose().

ast_verb_console_register()

void ast_verb_console_register

(

int *

level

)

Register this thread's console verbosity level pointer.

Parameters

level

Where the verbose level value is.

Definition at line 2713 of file logger.c.

{
    struct verb_console *console;
 
    console = ast_threadstorage_get(&my_verb_console, sizeof(*console));
    if (!console || !level) {
        return;
    }
    console->level = level;
 
    AST_RWLIST_WRLOCK(&verb_consoles);
    AST_RWLIST_INSERT_HEAD(&verb_consoles, console, node);
    AST_RWLIST_UNLOCK(&verb_consoles);
    ast_verb_update();
}

References AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_threadstorage_get(), ast_verb_update(), and verb_console::level.

Referenced by netconsole().

ast_verb_console_set()

void ast_verb_console_set

(

int

verb_level

)

Set this thread's console verbosity level.

Parameters

verb_level

New level to set.

Definition at line 2758 of file logger.c.

{
    struct verb_console *console;
 
    console = ast_threadstorage_get(&my_verb_console, sizeof(*console));
    if (!console) {
        return;
    }
 
    AST_RWLIST_WRLOCK(&verb_consoles);
    if (console->level) {
        *console->level = verb_level;
    } else {
        option_verbose = verb_level;
    }
    AST_RWLIST_UNLOCK(&verb_consoles);
    ast_verb_update();
}

References AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_threadstorage_get(), ast_verb_update(), and option_verbose.

Referenced by handle_verbose().

ast_verb_console_unregister()

void ast_verb_console_unregister

(

void

)

Unregister this thread's console verbosity level.

Definition at line 2729 of file logger.c.

{
    struct verb_console *console;
 
    console = ast_threadstorage_get(&my_verb_console, sizeof(*console));
    if (!console) {
        return;
    }
    verb_console_unregister(console);
}

References ast_threadstorage_get(), and verb_console_unregister().

Referenced by netconsole().

ast_verb_update()

void ast_verb_update

(

void

)

Re-evaluate the system max verbosity level (ast_verb_sys_level).

Definition at line 2651 of file logger.c.

{
    struct logchannel *log;
    struct verb_console *console;
    int verb_level;
 
    ast_mutex_lock(&verb_update_lock);
 
    AST_RWLIST_RDLOCK(&verb_consoles);
 
    /* Default to the root console verbosity. */
    verb_level = option_verbose;
 
    /* Determine max remote console level. */
    AST_LIST_TRAVERSE(&verb_consoles, console, node) {
        if (verb_level < *console->level) {
            verb_level = *console->level;
        }
    }
    AST_RWLIST_UNLOCK(&verb_consoles);
 
    /* Determine max logger channel level. */
    AST_RWLIST_RDLOCK(&logchannels);
    AST_RWLIST_TRAVERSE(&logchannels, log, list) {
        if (verb_level < log->verbosity) {
            verb_level = log->verbosity;
        }
    }
    AST_RWLIST_UNLOCK(&logchannels);
 
    ast_verb_sys_level = verb_level;
 
    ast_mutex_unlock(&verb_update_lock);
}

References AST_LIST_TRAVERSE, ast_mutex_lock, ast_mutex_unlock, AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_verb_sys_level, verb_console::level, option_verbose, verb_update_lock, and logchannel::verbosity.

Referenced by ast_verb_console_register(), ast_verb_console_set(), init_logger(), reload_logger(), and verb_console_unregister().