Asterisk - The Open Source Telephony Project GIT-master-25686a5
Macros | Typedefs | Enumerations | Functions | Variables
include/asterisk/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. More...
 
#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. More...
 
#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_RESULT(level, __var, __funcname, ...)    __var = __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) More...
 
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. More...
 
void ast_callid_strnprint (char *buffer, size_t buffer_size, ast_callid callid)
 copy a string representation of the callid into a target string More...
 
int ast_callid_threadassoc_add (ast_callid callid)
 Adds a known callid to thread storage of the calling thread. More...
 
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. More...
 
int ast_callid_threadassoc_remove (void)
 Removes callid from thread storage of the calling thread. More...
 
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. More...
 
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. More...
 
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 More...
 
void ast_console_puts_mutable (const char *string, int level)
 log the string to the console, and all attached console clients More...
 
void ast_console_puts_mutable_full (const char *message, int level, int sublevel)
 log the string to the console, and all attached console clients More...
 
void ast_console_toggle_loglevel (int fd, int level, int state)
 enables or disables logging of a specified level to the console 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) More...
 
void ast_console_toggle_mute (int fd, int silent)
 mute or unmute a console from logging More...
 
ast_callid ast_create_callid (void)
 factory function to create a new uniquely identifying callid. More...
 
unsigned int ast_debug_get_by_module (const char *module)
 Get the debug level for a module. More...
 
void ast_init_logger_for_socket_console (void)
 load logger.conf configuration for console socket connections More...
 
int ast_is_logger_initialized (void)
 Test if logger is initialized. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
int ast_logger_create_channel (const char *log_channel, const char *components)
 Create a log channel. More...
 
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. More...
 
const char * ast_logger_get_dateformat (void)
 Get the logger configured date format. More...
 
int ast_logger_get_dynamic_level (const char *name)
 Retrieve dynamic logging level id. More...
 
int ast_logger_get_queue_limit (void)
 Get the maximum number of messages allowed in the processing queue. More...
 
int ast_logger_register_level (const char *name)
 Register a new logger level. More...
 
int ast_logger_remove_channel (const char *log_channel)
 Delete the specified log channel. More...
 
int ast_logger_rotate (void)
 Reload logger while rotating log files. More...
 
int ast_logger_rotate_channel (const char *log_channel)
 Rotate the specified log channel. More...
 
void ast_logger_set_queue_limit (int queue_limit)
 Set the maximum number of messages allowed in the processing queue. More...
 
void ast_logger_unregister_level (const char *name)
 Unregister a previously registered logger level. More...
 
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 callerid from the thread More...
 
int ast_register_verbose (void(*verboser)(const char *string)) attribute_warn_unused_result
 
unsigned int ast_trace_get_by_module (const char *module)
 Get the trace level for a module. More...
 
int ast_unregister_verbose (void(*verboser)(const char *string)) attribute_warn_unused_result
 
int ast_verb_console_get (void)
 Get this thread's console verbosity level. More...
 
void ast_verb_console_register (int *level)
 Register this thread's console verbosity level pointer. More...
 
void ast_verb_console_set (int verb_level)
 Set this thread's console verbosity level. More...
 
void ast_verb_console_unregister (void)
 Unregister this thread's console verbosity level. More...
 
void ast_verb_update (void)
 Re-evaluate the system max verbosity level (ast_verb_sys_level). More...
 

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 247 of file include/asterisk/logger.h.

◆ __LOG_DTMF

#define __LOG_DTMF   6

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

◆ __LOG_ERROR

#define __LOG_ERROR   4

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

◆ __LOG_NOTICE

#define __LOG_NOTICE   2

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

◆ __LOG_TRACE

#define __LOG_TRACE   1

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

◆ __LOG_VERBOSE

#define __LOG_VERBOSE   5

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

◆ __LOG_WARNING

#define __LOG_WARNING   3

Definition at line 280 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)
#define DEBUG_ATLEAST(level)
#define AST_LOG_DEBUG

Log a DEBUG message.

Parameters
levelThe minimum value of option_debug for this message to get logged
Examples
app_skel.c.

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

◆ AST_LOG_DEBUG

#define AST_LOG_DEBUG   __LOG_DEBUG, _A_

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

◆ AST_LOG_DTMF

#define AST_LOG_DTMF   __LOG_DTMF, _A_

Definition at line 319 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
levelThe 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 444 of file include/asterisk/logger.h.

◆ AST_LOG_ERROR

#define AST_LOG_ERROR   __LOG_ERROR, _A_

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

◆ AST_LOG_NOTICE

#define AST_LOG_NOTICE   __LOG_NOTICE, _A_

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

◆ AST_LOG_TRACE

#define AST_LOG_TRACE   __LOG_TRACE, _A_

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

◆ AST_LOG_VERBOSE

#define AST_LOG_VERBOSE   __LOG_VERBOSE, _A_

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

◆ AST_LOG_WARNING

#define AST_LOG_WARNING   __LOG_WARNING, _A_

Definition at line 286 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)
#define _A_
#define VERBOSITY_ATLEAST(level)

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

◆ 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 475 of file include/asterisk/logger.h.

◆ ast_verbose

#define ast_verbose (   ...)    __ast_verbose(_A_, -1, __VA_ARGS__)

Definition at line 186 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 187 of file include/asterisk/logger.h.

◆ DEBUG_ATLEAST

#define DEBUG_ATLEAST (   level)
Value:
(option_debug >= (level) \
&& ((int)ast_debug_get_by_module(AST_MODULE) >= (level) \
|| (int)ast_debug_get_by_module(__FILE__) >= (level))))
#define AST_MODULE
int option_debug
Definition: options.c:69
unsigned int ast_debug_get_by_module(const char *module)
Get the debug level for a module.
Definition: main/cli.c:136
#define ast_opt_dbg_module
Definition: options.h:128

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

◆ DEBUG_M

#define DEBUG_M (   a)
Value:
{ \
a; \
}

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

◆ 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 248 of file include/asterisk/logger.h.

◆ LOG_DTMF

#define LOG_DTMF   __LOG_DTMF, _A_

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

◆ LOG_ERROR

#define LOG_ERROR   __LOG_ERROR, _A_
Examples
app_skel.c.

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

◆ LOG_NOTICE

#define LOG_NOTICE   __LOG_NOTICE, _A_

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

◆ LOG_TRACE

#define LOG_TRACE   __LOG_TRACE, _A_

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

◆ LOG_VERBOSE

#define LOG_VERBOSE   __LOG_VERBOSE, _A_

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

◆ LOG_WARNING

#define LOG_WARNING   __LOG_WARNING, _A_
Examples
app_skel.c.

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

◆ NUMLOGLEVELS

#define NUMLOGLEVELS   32

Definition at line 321 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 202 of file include/asterisk/logger.h.

◆ VERBOSE_MAGIC2LEVEL

#define VERBOSE_MAGIC2LEVEL (   x)    (((char) -*(signed char *) (x)) - 1)

Definition at line 201 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 466 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

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.

57 {
58 AST_LOGGER_SUCCESS = 0, /*!< Log channel was created or deleted successfully*/
59 AST_LOGGER_FAILURE = 1, /*!< Log channel already exists for create or doesn't exist for deletion of log channel */
60 AST_LOGGER_DECLINE = -1, /*!< Log channel request was not accepted */
61 AST_LOGGER_ALLOC_ERROR = -2 /*!< filename allocation error */
62};
@ AST_LOGGER_DECLINE
@ AST_LOGGER_FAILURE
@ AST_LOGGER_SUCCESS
@ AST_LOGGER_ALLOC_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 2550 of file logger.c.

2551{
2552 ast_callid callid;
2553 va_list ap;
2554
2556
2557 va_start(ap, fmt);
2558 __ast_verbose_ap(file, line, func, level, callid, fmt, ap);
2559 va_end(ap);
2560}
unsigned int ast_callid
void __ast_verbose_ap(const char *file, int line, const char *func, int level, ast_callid callid, const char *fmt, va_list ap)
Definition: logger.c:2545
ast_callid ast_read_threadstorage_callid(void)
extracts the callerid from the thread
Definition: logger.c:2298

References __ast_verbose_ap(), ast_read_threadstorage_callid(), and make_ari_stubs::file.

◆ __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 2545 of file logger.c.

2546{
2547 ast_log_full(__LOG_VERBOSE, level, file, line, func, callid, fmt, ap);
2548}
#define __LOG_VERBOSE
static void ast_log_full(int level, int sublevel, const char *file, int line, const char *function, ast_callid callid, const char *fmt, va_list ap)
send log messages to syslog and/or the console
Definition: logger.c:2389

References __LOG_VERBOSE, ast_log_full(), and make_ari_stubs::file.

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 2562 of file logger.c.

2563{
2564 va_list ap;
2565 va_start(ap, fmt);
2566 __ast_verbose_ap(file, line, func, level, callid, fmt, ap);
2567 va_end(ap);
2568}

References __ast_verbose_ap(), and make_ari_stubs::file.

◆ 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
bufferdestination of callid string (should be able to store 13 characters or more)
buffer_sizemaximum writable length of the string (Less than 13 will result in truncation)
callidCallid for which string is being requested

Definition at line 2288 of file logger.c.

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

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 2320 of file logger.c.

2321{
2322 ast_callid *pointing;
2323
2324 pointing = ast_threadstorage_get(&unique_callid, sizeof(*pointing));
2325 if (!pointing) {
2326 return -1;
2327 }
2328
2329 if (*pointing) {
2330 ast_log(LOG_ERROR, "ast_callid_threadassoc_add(C-%08x) on thread "
2331 "already associated with callid [C-%08x].\n", callid, *pointing);
2332 return 1;
2333 }
2334
2335 *pointing = callid;
2336 return 0;
2337}
#define LOG_ERROR
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 i...
Definition: logger.c:2453
static struct ast_threadstorage unique_callid
Definition: logger.c:93
void * ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size)
Retrieve thread storage.

References ast_log(), ast_threadstorage_get(), LOG_ERROR, and unique_callid.

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 2307 of file logger.c.

2308{
2309 ast_callid *id = ast_threadstorage_get(&unique_callid, sizeof(*id));
2310
2311 if (!id) {
2312 return -1;
2313 }
2314
2315 *id = callid;
2316
2317 return 0;
2318}

References ast_threadstorage_get(), and unique_callid.

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 2339 of file logger.c.

2340{
2341 ast_callid *pointing;
2342
2343 pointing = ast_threadstorage_get(&unique_callid, sizeof(*pointing));
2344 if (!pointing) {
2345 return -1;
2346 }
2347
2348 if (*pointing) {
2349 *pointing = 0;
2350 return 0;
2351 }
2352
2353 return -1;
2354}

References ast_threadstorage_get(), and unique_callid.

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
callidpointer 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 2356 of file logger.c.

2357{
2359
2360 /* Start by trying to see if a callid is available from thread storage */
2362 if (tmp) {
2363 *callid = tmp;
2364 return 0;
2365 }
2366
2367 /* If that failed, try to create a new one and bind it. */
2368 *callid = ast_create_callid();
2369 if (*callid) {
2371 return 1;
2372 }
2373
2374 /* If neither worked, then something must have gone wrong. */
2375 return -1;
2376}
static int tmp()
Definition: bt_open.c:389
int ast_callid_threadassoc_add(ast_callid callid)
Adds a known callid to thread storage of the calling thread.
Definition: logger.c:2320
ast_callid ast_create_callid(void)
factory function to create a new uniquely identifying callid.
Definition: logger.c:2293

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

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
callidThe callid set by ast_callid_threadstorage_auto
callid_createdThe integer returned through ast_callid_threadstorage_auto

Definition at line 2378 of file logger.c.

2379{
2380 if (callid && callid_created) {
2381 /* If the callid was created rather than simply grabbed from the thread storage, we need to unbind here. */
2383 }
2384}
int ast_callid_threadassoc_remove(void)
Removes callid from thread storage of the calling thread.
Definition: logger.c:2339

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 921 of file logger.c.

922{
923 char *msg = NULL, *emsg = NULL, *sptr, *eptr;
924 va_list ap, aq;
925 int size;
926
927 va_start(ap, fmt);
928 va_copy(aq, ap);
929 if ((size = vsnprintf(msg, 0, fmt, ap)) < 0) {
930 va_end(ap);
931 va_end(aq);
932 return;
933 }
934 va_end(ap);
935
936 if (!(msg = ast_malloc(size + 1))) {
937 va_end(aq);
938 return;
939 }
940
941 vsnprintf(msg, size + 1, fmt, aq);
942 va_end(aq);
943
944 if (!(emsg = ast_malloc(size * 2 + 1))) {
945 ast_free(msg);
946 return;
947 }
948
949 for (sptr = msg, eptr = emsg; ; sptr++) {
950 if (*sptr == '"') {
951 *eptr++ = '\\';
952 }
953 *eptr++ = *sptr;
954 if (*sptr == '\0') {
955 break;
956 }
957 }
958 ast_free(msg);
959
960 fprintf(stdout, "verbose \"%s\" %d\n", emsg, level);
961 fflush(stdout);
962 ast_free(emsg);
963}
#define ast_free(a)
Definition: astmm.h:180
#define ast_malloc(len)
A wrapper for malloc()
Definition: astmm.h:191
#define NULL
Definition: resample.c:96

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 1353 of file asterisk.c.

1354{
1355 /* Send to the root console */
1356 fputs(string, stdout);
1357 fflush(stdout);
1358
1359 /* Send to any network console clients */
1360 ast_network_puts(string);
1361}
static void ast_network_puts(const char *string)
write the string to all attached console clients
Definition: asterisk.c:1337

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
stringThe message to write to the console
levelThe 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 1313 of file asterisk.c.

1314{
1315 ast_console_puts_mutable_full(string, level, 0);
1316}
void ast_console_puts_mutable_full(const char *message, int level, int sublevel)
log the string to the console, and all attached console clients
Definition: asterisk.c:1320

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
messageThe message to write to the console
sublevelIf the log level supports it, the sub-level of the message
levelThe log level of the message

Definition at line 1320 of file asterisk.c.

1321{
1322 /* Send to the root console */
1324
1325 /* Wake up a poll()ing console */
1327 pthread_kill(consolethread, SIGURG);
1328 }
1329
1330 /* Send to any network console clients */
1331 ast_network_puts_mutable(message, level, sublevel);
1332}
static void ast_network_puts_mutable(const char *string, int level, int sublevel)
log the string to all attached network console clients
Definition: asterisk.c:1294
static pthread_t consolethread
Definition: asterisk.c:384
static int console_print(const char *s)
Definition: asterisk.c:2213
#define AST_PTHREADT_NULL
Definition: lock.h:66
#define ast_opt_console
Definition: options.h:111

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 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 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)

Definition at line 1248 of file asterisk.c.

1249{
1250 int x;
1251
1252 if (level >= NUMLOGLEVELS) {
1253 level = NUMLOGLEVELS - 1;
1254 }
1255
1256 for (x = 0;x < AST_MAX_CONNECTS; x++) {
1257 if (fd == consoles[x].fd) {
1258 /*
1259 * Since the logging occurs when levels are false, set to
1260 * flipped iinput because this function accepts 0 as off and 1 as on
1261 */
1262 consoles[x].levels[level] = state ? 0 : 1;
1263 return;
1264 }
1265 }
1266}
#define AST_MAX_CONNECTS
Definition: asterisk.c:296
struct console consoles[AST_MAX_CONNECTS]
Definition: asterisk.c:343
#define NUMLOGLEVELS
int levels[NUMLOGLEVELS]
Definition: asterisk.c:323

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 1271 of file asterisk.c.

1272{
1273 int x;
1274 for (x = 0;x < AST_MAX_CONNECTS; x++) {
1275 if (fd == consoles[x].fd) {
1276 if (consoles[x].mute) {
1277 consoles[x].mute = 0;
1278 if (!silent)
1279 ast_cli(fd, "Console is not muted anymore.\n");
1280 } else {
1281 consoles[x].mute = 1;
1282 if (!silent)
1283 ast_cli(fd, "Console is muted.\n");
1284 }
1285 return;
1286 }
1287 }
1288 ast_cli(fd, "Couldn't find remote console.\n");
1289}
void ast_cli(int fd, const char *fmt,...)
Definition: clicompat.c:6
int mute
Definition: asterisk.c:320

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 2293 of file logger.c.

2294{
2296}
int ast_atomic_fetchadd_int(volatile int *p, int v)
Atomically add v to *p and return the previous value of *p.
Definition: lock.h:757
static volatile int next_unique_callid
Definition: logger.c:90

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
modulethe name of module
Returns
the debug level

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

137{
138 struct module_level *ml;
139 unsigned int res = 0;
140
143 if (!strcasecmp(ml->module, module)) {
144 res = ml->level;
145 break;
146 }
147 }
149
150 return res;
151}
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition: linkedlists.h:78
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:491
static struct module_level_list debug_modules
Definition: main/cli.c:107
Definition: search.h:40
map a debug or verbose level to a module name
Definition: main/cli.c:98
unsigned int level
Definition: main/cli.c:99

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

◆ ast_is_logger_initialized()

int ast_is_logger_initialized ( void  )

Test if logger is initialized.

Return values
trueif the logger is initialized

Definition at line 2175 of file logger.c.

2176{
2177 return logger_initialized;
2178}
static int logger_initialized
Definition: logger.c:89

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
levelType of log event
fileWill be provided by the AST_LOG_* macro
lineWill be provided by the AST_LOG_* macro
functionWill be provided by the AST_LOG_* macro
fmtThis 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.

131{
132 va_list vars;
133 va_start(vars,fmt);
134
135 printf("LOG: lev:%d file:%s line:%d func: %s ",
136 level, file, line, function);
137 vprintf(fmt, vars);
138 fflush(stdout);
139 va_end(vars);
140}

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

Referenced by ast_callid_threadassoc_add(), ast_log_backtrace(), init_logger(), log_group_write(), logger_queue_init(), logger_queue_restart(), logger_register_level(), main(), and rotate_file().

◆ 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 2462 of file logger.c.

2463{
2464 ast_callid callid;
2465
2467
2468 if (level == __LOG_VERBOSE) {
2469 __ast_verbose_ap(file, line, function, 0, callid, fmt, ap);
2470 } else {
2471 ast_log_full(level, -1, file, line, function, callid, fmt, ap);
2472 }
2473}

References __ast_verbose_ap(), __LOG_VERBOSE, ast_log_full(), ast_read_threadstorage_callid(), logmsg::callid, make_ari_stubs::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 2510 of file logger.c.

2511{
2512#ifdef HAVE_BKTR
2513 struct ast_bt *bt;
2514 int i = 0;
2515 struct ast_vector_string *strings;
2516
2517 if (!(bt = ast_bt_create())) {
2518 ast_log(LOG_WARNING, "Unable to allocate space for backtrace structure\n");
2519 return;
2520 }
2521
2522 if ((strings = ast_bt_get_symbols(bt->addresses, bt->num_frames))) {
2523 int count = AST_VECTOR_SIZE(strings);
2524 struct ast_str *buf = ast_str_create(bt->num_frames * 64);
2525
2526 if (buf) {
2527 ast_str_append(&buf, 0, "Got %d backtrace record%c\n", count - 3, count - 3 != 1 ? 's' : ' ');
2528 for (i = 3; i < AST_VECTOR_SIZE(strings); i++) {
2529 ast_str_append(&buf, 0, "#%2d: %s\n", i - 3, AST_VECTOR_GET(strings, i));
2530 }
2532 ast_free(buf);
2533 }
2534
2535 ast_bt_free_symbols(strings);
2536 } else {
2537 ast_log(LOG_ERROR, "Could not allocate memory for backtrace\n");
2538 }
2539 ast_bt_destroy(bt);
2540#else
2541 ast_log(LOG_WARNING, "Must run configure with '--with-execinfo' for stack backtraces.\n");
2542#endif /* defined(HAVE_BKTR) */
2543}
#define ast_bt_free_symbols(string_vector)
Definition: backtrace.h:42
#define ast_bt_get_symbols(addresses, num_frames)
Definition: backtrace.h:41
#define ast_bt_create()
Definition: backtrace.h:39
#define ast_bt_destroy(bt)
Definition: backtrace.h:40
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
#define __LOG_ERROR
#define LOG_WARNING
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.
Definition: logger.c:2475
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition: strings.h:1139
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition: strings.h:659
A structure to hold backtrace information. This structure provides an easy means to store backtrace i...
Definition: backtrace.h:50
void * addresses[AST_MAX_BT_FRAMES]
Definition: backtrace.h:52
int num_frames
Definition: backtrace.h:54
Support for dynamic strings.
Definition: strings.h:623
String vector definitions.
Definition: vector.h:55
#define AST_VECTOR_SIZE(vec)
Get the number of elements in a vector.
Definition: vector.h:609
#define AST_VECTOR_GET(vec, idx)
Get an element from a vector.
Definition: vector.h:680

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
levelType of log event
fileWill be provided by the AST_LOG_* macro
lineWill be provided by the AST_LOG_* macro
functionWill be provided by the AST_LOG_* macro
callidThis is the ast_callid that is associated with the log message. May be NULL.
fmtThis is what is important. The format is the same as your favorite breed of printf. You know how that works, right? :-)

Definition at line 2501 of file logger.c.

2502{
2503 va_list ap;
2504 va_start(ap, fmt);
2505 ast_log_full(level, -1, file, line, function, callid, fmt, ap);
2506 va_end(ap);
2507}

References ast_log_full(), logmsg::callid, make_ari_stubs::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 2475 of file logger.c.

2476{
2477 va_list ap;
2478 void *recursed = ast_threadstorage_get_ptr(&in_safe_log);
2479 ast_callid callid;
2480
2481 if (recursed) {
2482 return;
2483 }
2484
2485 if (ast_threadstorage_set_ptr(&in_safe_log, &(int) { 1 })) {
2486 /* We've failed to set the flag that protects against
2487 * recursion, so bail. */
2488 return;
2489 }
2490
2492
2493 va_start(ap, fmt);
2494 ast_log_full(level, -1, file, line, function, callid, fmt, ap);
2495 va_end(ap);
2496
2497 /* Clear flag so the next allocation failure can be logged. */
2498 ast_threadstorage_set_ptr(&in_safe_log, NULL);
2499}
int ast_threadstorage_set_ptr(struct ast_threadstorage *ts, void *ptr)
Set a raw pointer from threadstorage.
void * ast_threadstorage_get_ptr(struct ast_threadstorage *ts)
Retrieve a raw pointer from threadstorage.

References ast_log_full(), ast_read_threadstorage_callid(), ast_threadstorage_get_ptr(), ast_threadstorage_set_ptr(), logmsg::callid, make_ari_stubs::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_channelLog channel to create
componentsLogging config levels to add to the log channel

Definition at line 1521 of file logger.c.

1522{
1523 struct logchannel *chan;
1524
1526 return AST_LOGGER_DECLINE;
1527 }
1528
1530
1531 chan = find_logchannel(log_channel);
1532 if (chan) {
1534 return AST_LOGGER_FAILURE;
1535 }
1536
1537 chan = make_logchannel(log_channel, components, 0, 1);
1538 if (!chan) {
1541 }
1542
1544 global_logmask |= chan->logmask;
1545
1547
1548 return AST_LOGGER_SUCCESS;
1549}
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
#define AST_RWLIST_INSERT_HEAD
Definition: linkedlists.h:718
static unsigned int global_logmask
Definition: logger.c:87
static struct logchannel * make_logchannel(const char *channel, const char *components, int lineno, int dynamic)
Definition: logger.c:646
static struct logchannel * find_logchannel(const char *channel)
Find a particular logger channel by name.
Definition: logger.c:630
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
struct logchannel::@368 list
unsigned int logmask
Definition: logger.c:142
char components[0]
Definition: logger.c:162

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_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
logentryA callback to an updater function
dataData 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
0on success
1on failure
-2on allocation error

Definition at line 1409 of file logger.c.

1411{
1412 struct logchannel *chan;
1413 struct ast_str *configs = ast_str_create(64);
1414 int res = AST_LOGGER_SUCCESS;
1415
1416 if (!configs) {
1418 }
1419
1421 AST_RWLIST_TRAVERSE(&logchannels, chan, list) {
1422 unsigned int level;
1423
1425
1426 for (level = 0; level < ARRAY_LEN(levels); level++) {
1427 if ((chan->logmask & (1 << level)) && levels[level]) {
1428 ast_str_append(&configs, 0, "%s ", levels[level]);
1429 }
1430 }
1431
1432 res = logentry(chan->filename, chan->type == LOGTYPE_CONSOLE ? "Console" :
1433 (chan->type == LOGTYPE_SYSLOG ? "Syslog" : "File"), chan->disabled ?
1434 "Disabled" : "Enabled", ast_str_buffer(configs), data);
1435
1436 if (res) {
1439 configs = NULL;
1440 return AST_LOGGER_FAILURE;
1441 }
1442 }
1444
1446 configs = NULL;
1447
1448 return AST_LOGGER_SUCCESS;
1449}
#define AST_RWLIST_TRAVERSE
Definition: linkedlists.h:494
static char * levels[NUMLOGLEVELS]
Logging channels used in the Asterisk logging system.
Definition: logger.c:214
@ LOGTYPE_CONSOLE
Definition: logger.c:135
@ LOGTYPE_SYSLOG
Definition: logger.c:133
void ast_str_reset(struct ast_str *buf)
Reset the content of a dynamic string. Useful before a series of ast_str_append.
Definition: strings.h:693
enum logtypes type
Definition: logger.c:150
char filename[PATH_MAX]
Definition: logger.c:154
int disabled
Definition: logger.c:144
#define ARRAY_LEN(a)
Definition: utils.h:666

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 2927 of file logger.c.

2928{
2929 return dateformat;
2930}
static char dateformat[256]
Definition: logger.c:81

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
nameThe name of the level
Returns
The unique integer id for the given level
Return values
-1if level name not found

Definition at line 2880 of file logger.c.

2881{
2882 int level = -1;
2883
2885
2887
2889
2890 return level;
2891}
static const char name[]
Definition: format_mp3.c:68
static int logger_get_dynamic_level(const char *name)
Definition: logger.c:2862

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

Referenced by log_exec().

◆ 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 2937 of file logger.c.

2938{
2939 return logger_queue_limit;
2940}
static int logger_queue_limit
Definition: logger.c:96

References logger_queue_limit.

Referenced by handle_cli_queue_test().

◆ ast_logger_register_level()

int ast_logger_register_level ( const char *  name)

Register a new logger level.

Parameters
nameThe name of the level to be registered
Return values
-1if an error occurs
non-zerolevel to be used with ast_log for sending messages to this level
Since
1.8

Definition at line 2851 of file logger.c.

2852{
2853 int available = 0;
2854
2858
2859 return available;
2860}
static int available(struct dahdi_pvt **pvt, int is_specific_channel)
Definition: chan_dahdi.c:13472
static int logger_register_level(const char *name)
Definition: logger.c:2814

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_test(), and load_module().

◆ ast_logger_remove_channel()

int ast_logger_remove_channel ( const char *  log_channel)

Delete the specified log channel.

Parameters
log_channelThe log channel to delete

Definition at line 1587 of file logger.c.

1588{
1589 struct logchannel *chan;
1590
1592
1593 chan = find_logchannel(log_channel);
1594 if (chan && chan->dynamic) {
1596 } else {
1598 return AST_LOGGER_FAILURE;
1599 }
1601
1602 if (chan->fileptr) {
1603 fclose(chan->fileptr);
1604 chan->fileptr = NULL;
1605 }
1606 ast_free(chan);
1607 chan = NULL;
1608
1609 return AST_LOGGER_SUCCESS;
1610}
#define AST_RWLIST_REMOVE
Definition: linkedlists.h:885
int dynamic
Definition: logger.c:160
FILE * fileptr
Definition: logger.c:152

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_test(), and handle_logger_remove_channel().

◆ ast_logger_rotate()

int ast_logger_rotate ( void  )

Reload logger while rotating log files.

Definition at line 1327 of file logger.c.

1328{
1329 return reload_logger(1, NULL);
1330}
static int reload_logger(int rotate, const char *altconf)
Definition: logger.c:1212

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_channelThe log channel to rotate

Definition at line 1332 of file logger.c.

1333{
1334 struct logchannel *f;
1335 int success = AST_LOGGER_FAILURE;
1336 char filename[PATH_MAX];
1337
1338 make_filename(log_channel, filename, sizeof(filename));
1339
1341
1343
1345 if (f->disabled) {
1346 f->disabled = 0; /* Re-enable logging at reload */
1347 manager_event(EVENT_FLAG_SYSTEM, "LogChannel", "Channel: %s\r\nEnabled: Yes\r\n",
1348 f->filename);
1349 }
1350 if (f->fileptr && (f->fileptr != stdout) && (f->fileptr != stderr)) {
1351 fclose(f->fileptr); /* Close file */
1352 f->fileptr = NULL;
1353 if (strcmp(filename, f->filename) == 0) {
1355 success = AST_LOGGER_SUCCESS;
1356 }
1357 }
1358 }
1359
1361
1363
1364 return success;
1365}
#define PATH_MAX
Definition: asterisk.h:40
static void make_filename(const char *channel, char *filename, size_t size)
create the filename that will be used for a logger channel.
Definition: logger.c:589
static int init_logger_chain(const char *altconf)
Read config, setup channels.
Definition: logger.c:759
static int rotate_file(const char *filename)
Definition: logger.c:1045
#define manager_event(category, event, contents,...)
External routines may send asterisk manager events this way.
Definition: manager.h:253
#define EVENT_FLAG_SYSTEM
Definition: manager.h:75
const char * ast_config_AST_LOG_DIR
Definition: options.c:159
int ast_mkdir(const char *path, int mode)
Recursively create directory path.
Definition: utils.c:2479

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_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 2932 of file logger.c.

2933{
2934 logger_queue_limit = queue_limit;
2935}

References logger_queue_limit.

Referenced by handle_cli_queue_test().

◆ ast_logger_unregister_level()

void ast_logger_unregister_level ( const char *  name)

Unregister a previously registered logger level.

Parameters
nameThe name of the level to be unregistered
Since
1.8

Definition at line 2909 of file logger.c.

2910{
2911 int x;
2912
2915
2916 if (x) {
2918 }
2919
2921
2922 if (x) {
2923 ast_debug(1, "Unregistered dynamic logger level '%s' with index %u.\n", name, x);
2924 }
2925}
#define ast_debug(level,...)
Log a DEBUG message.
static void update_logchannels(void)
Definition: logger.c:2710
static int logger_unregister_level(const char *name)
Definition: logger.c:2893

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_test(), load_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 965 of file logger.c.

966{
967 va_list ap;
968 struct timeval tv;
969 struct ast_tm tm;
970 char qlog_msg[8192];
971 int qlog_len;
972 char time_str[30];
973
974 if (!logger_initialized) {
975 /* You are too early. We are not open yet! */
976 return;
977 }
978 if (!queuelog_init) {
979 /* We must initialize now since someone is trying to log something. */
981 }
982
983 if (ast_check_realtime("queue_log")) {
984 tv = ast_tvnow();
985 ast_localtime(&tv, &tm, logfiles.queue_log_realtime_use_gmt ? "GMT" : NULL);
986 ast_strftime(time_str, sizeof(time_str), "%F %T.%6q", &tm);
987 va_start(ap, fmt);
988 vsnprintf(qlog_msg, sizeof(qlog_msg), fmt, ap);
989 va_end(ap);
990 if (logfiles.queue_adaptive_realtime) {
992 AST_APP_ARG(data)[5];
993 );
994 AST_NONSTANDARD_APP_ARGS(args, qlog_msg, '|');
995 /* Ensure fields are large enough to receive data */
996 ast_realtime_require_field("queue_log",
997 "data1", RQ_CHAR, strlen(S_OR(args.data[0], "")),
998 "data2", RQ_CHAR, strlen(S_OR(args.data[1], "")),
999 "data3", RQ_CHAR, strlen(S_OR(args.data[2], "")),
1000 "data4", RQ_CHAR, strlen(S_OR(args.data[3], "")),
1001 "data5", RQ_CHAR, strlen(S_OR(args.data[4], "")),
1002 SENTINEL);
1003
1004 /* Store the log */
1005 ast_store_realtime("queue_log", "time", time_str,
1006 "callid", callid,
1007 "queuename", queuename,
1008 "agent", agent,
1009 "event", event,
1010 "data1", S_OR(args.data[0], ""),
1011 "data2", S_OR(args.data[1], ""),
1012 "data3", S_OR(args.data[2], ""),
1013 "data4", S_OR(args.data[3], ""),
1014 "data5", S_OR(args.data[4], ""),
1015 SENTINEL);
1016 } else {
1017 ast_store_realtime("queue_log", "time", time_str,
1018 "callid", callid,
1019 "queuename", queuename,
1020 "agent", agent,
1021 "event", event,
1022 "data", qlog_msg,
1023 SENTINEL);
1024 }
1025
1026 if (!logfiles.queue_log_to_file) {
1027 return;
1028 }
1029 }
1030
1031 if (qlog) {
1032 va_start(ap, fmt);
1033 qlog_len = snprintf(qlog_msg, sizeof(qlog_msg), "%ld|%s|%s|%s|%s|", (long)time(NULL), callid, queuename, agent, event);
1034 vsnprintf(qlog_msg + qlog_len, sizeof(qlog_msg) - qlog_len, fmt, ap);
1035 va_end(ap);
1037 if (qlog) {
1038 fprintf(qlog, "%s\n", qlog_msg);
1039 fflush(qlog);
1040 }
1042 }
1043}
#define SENTINEL
Definition: compiler.h:87
#define AST_APP_ARG(name)
Define an application argument.
#define AST_DECLARE_APP_ARGS(name, arglist)
Declare a structure to hold an application's arguments.
#define AST_NONSTANDARD_APP_ARGS(args, parse, sep)
Performs the 'nonstandard' argument separation process for an application.
int ast_realtime_require_field(const char *family,...) attribute_sentinel
Inform realtime what fields that may be stored.
Definition: main/config.c:3549
int ast_check_realtime(const char *family)
Check if realtime engine is configured for family.
Definition: main/config.c:3530
int ast_store_realtime(const char *family,...) attribute_sentinel
Create realtime configuration.
Definition: main/config.c:3740
struct ast_tm * ast_localtime(const struct timeval *timep, struct ast_tm *p_tm, const char *zone)
Timezone-independent version of localtime_r(3).
Definition: localtime.c:1739
int ast_strftime(char *buf, size_t len, const char *format, const struct ast_tm *tm)
Special version of strftime(3) that handles fractions of a second. Takes the same arguments as strfti...
Definition: localtime.c:2524
static int queuelog_init
Definition: logger.c:88
void logger_queue_start(void)
Start the ast_queue_log() logger.
Definition: logger.c:2186
static FILE * qlog
Definition: logger.c:201
static struct @367 logfiles
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition: strings.h:80
Definition: astman.c:222
const char * args
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition: time.h:159

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 callerid from the thread

Return values
Non-zeroCall id related to the thread
0if no call_id is present in the thread

Definition at line 2298 of file logger.c.

2299{
2300 ast_callid *callid;
2301
2302 callid = ast_threadstorage_get(&unique_callid, sizeof(*callid));
2303
2304 return callid ? *callid : 0;
2305}

References ast_threadstorage_get(), and unique_callid.

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_register_verbose()

int ast_register_verbose ( void(*)(const char *string verboser)

◆ ast_unregister_verbose()

int ast_unregister_verbose ( void(*)(const char *string verboser)

◆ 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 2673 of file logger.c.

2674{
2675 struct verb_console *console;
2676 int verb_level;
2677
2680 if (!console) {
2681 verb_level = 0;
2682 } else if (console->level) {
2683 verb_level = *console->level;
2684 } else {
2685 verb_level = option_verbose;
2686 }
2688 return verb_level;
2689}
int option_verbose
Definition: options.c:67
static struct ast_threadstorage my_verb_console
Definition: logger.c:2644

References AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_threadstorage_get(), my_verb_console, 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
levelWhere the verbose level value is.

Definition at line 2646 of file logger.c.

2647{
2648 struct verb_console *console;
2649
2651 if (!console || !level) {
2652 return;
2653 }
2654 console->level = level;
2655
2660}
void ast_verb_update(void)
Re-evaluate the system max verbosity level (ast_verb_sys_level).
Definition: logger.c:2584
Definition: test_heap.c:38
int * level
Definition: logger.c:2575

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

Referenced by netconsole().

◆ ast_verb_console_set()

void ast_verb_console_set ( int  verb_level)

Set this thread's console verbosity level.

Parameters
verb_levelNew level to set.

Definition at line 2691 of file logger.c.

2692{
2693 struct verb_console *console;
2694
2696 if (!console) {
2697 return;
2698 }
2699
2701 if (console->level) {
2702 *console->level = verb_level;
2703 } else {
2704 option_verbose = verb_level;
2705 }
2708}

References AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_threadstorage_get(), ast_verb_update(), my_verb_console, 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 2662 of file logger.c.

2663{
2664 struct verb_console *console;
2665
2667 if (!console) {
2668 return;
2669 }
2671}
static void verb_console_unregister(struct verb_console *console)
Definition: logger.c:2625

References ast_threadstorage_get(), my_verb_console, 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 2584 of file logger.c.

2585{
2586 struct logchannel *log;
2587 struct verb_console *console;
2588 int verb_level;
2589
2591
2593
2594 /* Default to the root console verbosity. */
2595 verb_level = option_verbose;
2596
2597 /* Determine max remote console level. */
2599 if (verb_level < *console->level) {
2600 verb_level = *console->level;
2601 }
2602 }
2604
2605 /* Determine max logger channel level. */
2607 AST_RWLIST_TRAVERSE(&logchannels, log, list) {
2608 if (verb_level < log->verbosity) {
2609 verb_level = log->verbosity;
2610 }
2611 }
2613
2614 ast_verb_sys_level = verb_level;
2615
2617}
int ast_verb_sys_level
Definition: options.c:64
#define ast_mutex_unlock(a)
Definition: lock.h:190
#define ast_mutex_lock(a)
Definition: lock.h:189
static ast_mutex_t verb_update_lock
Definition: logger.c:2582
int verbosity
Definition: logger.c:148

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().