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

#include "asterisk/options.h"

Include dependency graph for logger.h:

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__, __PRETTY_FUNCTION__

#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, __FILE__, __LINE__, __PRETTY_FUNCTION__, __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, ...)
	Print a basic trace message. More...

#define	ast_trace_dec_indent() _ast_trace_dec_indent()

#define	ast_trace_get_indent() _ast_trace_get_indent()

#define	ast_trace_inc_indent() _ast_trace_inc_indent()

#define	ast_trace_log(__level, __log_level, ...)

#define	ast_trace_raw(level, indent_type, ...)
	Print a trace message. More...

#define	ast_trace_set_indent(indent) _ast_trace_set_indent(indent)

#define	ast_verb(level, ...)

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

#define	ast_verbose(...) __ast_verbose(__FILE__, __LINE__, __PRETTY_FUNCTION__, -1, __VA_ARGS__)

#define	ast_verbose_callid(callid, ...) __ast_verbose_callid(__FILE__, __LINE__, __PRETTY_FUNCTION__, -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_ENTER(level, ...)
	Non RAII_VAR Scope Trace macros The advantage of these macros is that the EXITs will have the actual line number where the scope exited. Much less code is required as well. More...

#define	SCOPE_ENTER_TASK(level, indent, ...)

#define	SCOPE_EXIT(...)
	Scope Exit. More...

#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(...)
	Scope Exit with return. More...

#define	SCOPE_EXIT_RTN_VALUE(__return_value, ...)
	Scope Exit with return value. More...

#define	SCOPE_TRACE(level, ...)
	Print a trace message with details when a scope is entered or existed. More...

#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_2 " == "

#define	VERBOSE_PREFIX_3 " -- "

#define	VERBOSE_PREFIX_4 " > "

#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_trace (const char file, int line, const char func, enum ast_trace_indent_type indent_type, unsigned long indent, const char *format,...)

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

unsigned long	_ast_trace_dec_indent (void)
	Decrement the indent level. More...

unsigned long	_ast_trace_get_indent (void)
	Get the current indent level. More...

unsigned long	_ast_trace_inc_indent (void)
	Increment the indent level. More...

void	_ast_trace_set_indent (unsigned long indent)
	Set the current indent level. 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...

int	ast_dynamic_logger_level (const char *name)
	Checks if a dynamic logger level exists. 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_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 logger.h.

Macro Definition Documentation

◆ __LOG_DEBUG

#define __LOG_DEBUG 0

Definition at line 240 of file logger.h.

Referenced by _ast_sockaddr_from_sin(), _ast_sockaddr_port(), _ast_sockaddr_set_port(), _ast_sockaddr_to_sin(), get_log_level(), internal_ao2_alloc(), log_caps(), and log_exec().

◆ __LOG_DTMF

#define __LOG_DTMF 6

Definition at line 306 of file logger.h.

Referenced by log_exec().

◆ __LOG_ERROR

#define __LOG_ERROR 4

Definition at line 284 of file logger.h.

Referenced by __ao2_container_alloc_rbtree(), __ao2_lock(), __ao2_ref(), __ao2_trylock(), __ao2_unlock(), __ast_assert_failed(), __ast_fd_set_flags(), _ast_sockaddr_to_sin(), ast_log_backtrace(), get_log_level(), init_logger_chain(), internal_ao2_alloc(), log_exec(), and make_logchannel().

◆ __LOG_NOTICE

#define __LOG_NOTICE 2

Definition at line 262 of file logger.h.

Referenced by get_log_level(), and log_exec().

◆ __LOG_TRACE

#define __LOG_TRACE 1

Definition at line 251 of file logger.h.

Referenced by __ast_trace().

◆ __LOG_VERBOSE

#define __LOG_VERBOSE 5

Definition at line 295 of file logger.h.

Referenced by __ast_verbose_ap(), ast_log_ap(), ast_log_full(), ast_network_puts_mutable(), format_log_default(), format_log_message_ap(), get_log_level(), log_exec(), logger_print_normal(), and make_components().

◆ __LOG_WARNING

#define __LOG_WARNING 3

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/strings.h.

Definition at line 273 of file logger.h.

Referenced by _ast_addressfamily_to_sockaddrsize(), _ast_strlen_zero(), ast_log_full(), get_log_level(), log_exec(), and logger_thread().

◆ _A_

#define _A_ __FILE__, __LINE__, __PRETTY_FUNCTION__

Definition at line 235 of file logger.h.

◆ AST_CALLID_BUFFER_LENGTH

#define AST_CALLID_BUFFER_LENGTH 13

Definition at line 46 of file logger.h.

Referenced by ast_channel_callid_set(), and iax_pvt_callid_new().

◆ 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:: /usr/src/asterisk-18.5.0/main/app.c.

Definition at line 452 of file logger.h.

◆ AST_LOG_DEBUG

#define AST_LOG_DEBUG __LOG_DEBUG, _A_

Definition at line 246 of file logger.h.

◆ AST_LOG_DTMF

#define AST_LOG_DTMF __LOG_DTMF, _A_

Definition at line 312 of file logger.h.

◆ ast_log_dynamic_level

#define ast_log_dynamic_level	(	level,
		...
	)	ast_log(level, __FILE__, __LINE__, __PRETTY_FUNCTION__, __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.

Returns: nothing

Since: 1.8

Definition at line 439 of file logger.h.

Referenced by append_history_va(), ast_cc_agent_set_interfaces_chanvar(), ast_cc_call_init(), ast_cc_monitor_count(), ast_fax_log(), ast_handle_cc_control_frame(), ast_set_cc_interfaces_chanvar(), cc_agent_init(), cc_caller_offered(), cc_core_init_instance(), cc_core_instance_destructor(), cc_device_monitor_init(), cc_do_state_change(), cc_extension_monitor_init(), cc_generic_agent_start_offer_timer(), cc_generic_monitor_cancel_available_timer(), cc_generic_monitor_destructor(), cc_interface_destroy(), cc_monitor_destroy(), cc_monitor_failed(), cc_request_state_change(), cccancel_exec(), ccreq_exec(), ccss_device_state(), ccss_notify_device_state_change(), count_agents(), count_agents_cb(), find_agent_callbacks(), find_monitor_callbacks(), generic_recall(), handle_cli_dynamic_level_test(), handle_cli_performance_test(), handle_cli_queue_test(), history_on_rx_msg(), history_on_tx_msg(), is_state_change_valid(), log_exec(), offer_timer_expire(), and security_event_stasis_cb().

◆ AST_LOG_ERROR

#define AST_LOG_ERROR __LOG_ERROR, _A_

Definition at line 290 of file logger.h.

Referenced by _sip_show_peers(), actual_load_config(), add_header(), ari_channels_handle_originate_with_id(), ast_ari_channels_continue_in_dialplan(), ast_cdr_getvar(), ast_cdr_serialize_variables(), ast_cdr_setvar(), AST_TEST_DEFINE(), ast_xml_doc_item_alloc(), ast_xmldoc_build_documentation(), cdr_toggle_runtime_options(), copy_message(), create_routes(), determine_actual_value(), file_read(), file_write(), forward_message(), func_read_header(), func_write_header(), handle_manager_show_events(), hep_queue_cb(), hepv3_config_pre_apply(), incoming_request(), json_to_ast_variables(), leave_voicemail(), load_config(), load_module(), logged_dlclose(), msg_create_from_file(), open_mailbox(), pjsip_aor_function_read(), pjsip_contact_function_read(), pjsip_endpoint_function_read(), play_message(), prometheus_config_pre_apply(), read_header(), receivefax_exec(), reload(), remove_header(), run_externnotify(), save_to_folder(), security_event_to_ami_blob(), sendfax_exec(), sorcery_function_read(), statsd_exec(), subscribe_all(), syslog_log(), test_jb_error_output(), test_vm_api_create_voicemail_files(), test_vm_api_create_voicemail_folder(), test_vm_api_test_setup(), unload_module(), update_header(), validate_metric(), validate_metric_type_counter(), validate_metric_type_gauge(), validate_metric_type_set(), validate_metric_type_timer(), validate_name(), validate_numeric(), vm_allocate_dh(), vm_exec(), vm_mailbox_snapshot_create(), and vm_msg_remove().

◆ AST_LOG_NOTICE

#define AST_LOG_NOTICE __LOG_NOTICE, _A_

◆ AST_LOG_TRACE

#define AST_LOG_TRACE __LOG_TRACE, _A_

Definition at line 257 of file logger.h.

◆ AST_LOG_VERBOSE

#define AST_LOG_VERBOSE __LOG_VERBOSE, _A_

Definition at line 301 of file logger.h.

◆ AST_LOG_WARNING

#define AST_LOG_WARNING __LOG_WARNING, _A_

Definition at line 279 of file logger.h.

Referenced by actual_load_config(), add_email_attachment(), adsi_begin(), advanced_options(), app_send(), appcdr_callback(), apply_option(), ast_cdr_generic_unregister(), ast_module_reload(), ast_parking_register_bridge_features(), ast_parking_unregister_bridge_features(), ast_serializer_pool_set_alerts(), ast_srtp_add_stream(), AST_TEST_DEFINE(), au_seek(), au_trunc(), base_encode(), bridge_channel_park(), bridge_impart_internal(), cdr_prop_write(), cdr_prop_write_callback(), cdr_read(), cdr_read_callback(), cdr_retrieve_time(), channel_chanspy_start_cb(), channel_chanspy_stop_cb(), channel_read_pjsip(), channel_read_rtcp(), channel_read_rtp(), check_password(), close_mailbox(), copy(), create_dirpath(), dtmfstore_exec(), filestream_close(), forkcdr_callback(), forkcdr_exec(), forward_message(), free_zone(), g719seek(), g719trunc(), g723_trunc(), g726_seek(), g729_trunc(), gsm_seek(), gsm_tell(), gsm_trunc(), h263_trunc(), h264_trunc(), handle_bridge_enter_message(), handle_bridge_leave_message(), handle_channel_snapshot_update_message(), handle_dial_message(), handle_parked_call_message(), handle_request_info(), hep_queue_cb(), hepv3_data_alloc(), hold_intercept_fn_write(), ilbc_trunc(), initialize_udptl(), invent_message(), is_valid_dtmf(), leave_voicemail(), load_config(), load_module(), load_zonemessages(), make_email_file(), manager_generic_msg_cb(), message_playback_callback_fn(), msg_create_from_file(), mwi_app_event_cb(), non_neg_value_range(), notify_new_message(), odbc_log(), parking_park_call(), parse_uri_cb(), pbx_builtin_answer(), pbx_builtin_setamaflags(), pcm_seek(), pcm_trunc(), pjsip_aor_function_read(), pjsip_contact_function_read(), pjsip_endpoint_function_read(), play_message(), play_message_by_id_helper(), play_message_category(), play_message_datetime(), play_record_review(), prometheus_metric_register(), publish_app_cdr_message(), publish_chanspy_message(), read_pjsip(), reload_module(), remove_detect(), remove_dtmf_store(), remove_hold_intercept(), remove_scrambler(), remove_talk_detect(), res_srtp_init(), run_externnotify(), sendmail(), sendpage(), set_hold_intercept(), siren14seek(), siren14trunc(), siren7seek(), siren7trunc(), slinear_seek(), slinear_trunc(), softmix_bridge_create(), talk_detect_fn_write(), test_jb_warn_output(), test_vm_api_remove_all_messages(), value_in_range(), vm_allocate_dh(), vm_authenticate(), vm_change_password(), vm_exec(), vm_execmain(), vm_mailbox_snapshot_create(), vm_msg_play(), vox_seek(), vox_trunc(), wait_file2(), wav_seek(), and wav_trunc().

◆ ast_trace

#define ast_trace	(	level,
		...
	)

Value:

ast_debug(level < 0 ? __scope_level : level, " " __VA_ARGS__); \
   if (TRACE_ATLEAST(level < 0 ? __scope_level : level)) { \
      __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, AST_TRACE_INDENT_SAME, 0, " " __VA_ARGS__); \
   }

Print a basic trace message.

Parameters

level	The trace level
(optional)	A printf style format string
(optional)	Arguments

This will print the file, line and function at the current indent level

Definition at line 692 of file logger.h.

Referenced by ast_sip_session_media_state_add(), ast_stream_create_resolved(), AST_TEST_DEFINE(), chan_pjsip_incoming_ack(), chan_pjsip_incoming_response(), chan_pjsip_indicate(), create_local_sdp(), dial_exec_full(), handle_incoming_sdp(), invite_proceeding(), invite_terminated(), new_invite(), resolve_refresh_media_states(), session_inv_on_media_update(), session_on_tsx_state(), sfu_topologies_on_join(), sip_session_refresh(), softmix_bridge_stream_sources_update(), and wait_for_answer().

◆ ast_trace_dec_indent

#define ast_trace_dec_indent ( ) _ast_trace_dec_indent()

Definition at line 728 of file logger.h.

◆ ast_trace_get_indent

#define ast_trace_get_indent ( ) _ast_trace_get_indent()

Definition at line 704 of file logger.h.

Referenced by chan_pjsip_answer().

◆ ast_trace_inc_indent

#define ast_trace_inc_indent ( ) _ast_trace_inc_indent()

Definition at line 720 of file logger.h.

◆ ast_trace_log

#define ast_trace_log	(	__level,
		__log_level,
		...
	)

Value:

({ \
   ast_log(__log_level, " " __VA_ARGS__); \
   ast_trace(__level < 0 ? __scope_level : __level, " " __VA_ARGS__); \
})

Definition at line 952 of file logger.h.

Referenced by new_invite().

◆ ast_trace_raw

#define ast_trace_raw	(	level,
		indent_type,
		...
	)

Value:

ast_debug(level < 0 ? __scope_level : level, " " __VA_ARGS__); \
   if (TRACE_ATLEAST(level < 0 ? __scope_level : level)) { \
      __ast_trace(__FILE__, __LINE__, __PRETTY_FUNCTION__, indent_type, 0, " " __VA_ARGS__); \
   }

Print a trace message.

Parameters

level	The trace level
indent_type	One of the ast_trace_indent_type values
(optional)	A printf style format string
(optional)	Arguments

Definition at line 677 of file logger.h.

◆ ast_trace_set_indent

#define ast_trace_set_indent ( indent ) _ast_trace_set_indent(indent)

Definition at line 712 of file logger.h.

◆ ast_verb

#define ast_verb	(	level,
		...
	)

Value:

do { \
      if (VERBOSITY_ATLEAST(level) ) { \
         __ast_verbose(__FILE__, __LINE__, __PRETTY_FUNCTION__, level, __VA_ARGS__); \
      } \
   } while (0)

Examples:: /usr/src/asterisk-18.5.0/main/app.c.

Definition at line 463 of file logger.h.

Referenced by __analog_handle_event(), __analog_ss_thread(), __ast_bridge_technology_register(), __ast_bucket_scheme_register(), __ast_codec_register_with_format(), __ast_context_destroy(), __ast_custom_function_register(), __ast_format_def_register(), __ast_format_interface_register(), __ast_http_load(), __ast_pbx_run(), __ast_play_and_record(), __ast_register_translator(), __ast_sorcery_wizard_register(), __dahdi_exception(), __ssl_setup(), _if_exec(), _macro_exec(), _while_exec(), acf_odbc_read(), action_hangup(), action_login(), add_realm_authentication(), add_vm_recipients_from_string(), ademco_detect_format(), ademco_verify_checksum(), adsi_exec(), adsi_prog(), advanced_options(), agent_login_exec(), agent_logout(), agent_request_exec(), agent_thread(), alarmreceiver_exec(), alloc_notify_task_data(), analog_attempt_transfer(), analog_dnd(), analog_exception(), analog_handle_init_event(), analog_hangup(), analog_ss_thread(), announce_to_dial(), aoc_display_decoded_debug(), app_create(), app_deactivate(), app_dtor(), app_exec(), app_send(), app_update(), ari_originate_dial(), ast_agi_register(), ast_agi_unregister(), ast_bridge_set_single_src_video_mode(), ast_bridge_technology_unregister(), ast_bridge_timelimit(), ast_bridge_update_talker_src_video_mode(), ast_calendar_register(), ast_calendar_unregister(), ast_cdr_generic_unregister(), ast_channel_register(), ast_channel_unregister(), ast_config_text_file_save2(), ast_context_add_switch2(), ast_context_remove_extension_callerid2(), ast_context_remove_include2(), ast_context_remove_switch2(), ast_custom_function_unregister(), ast_dns_resolver_register(), ast_dns_resolver_unregister(), ast_eivr_senddtmf(), ast_fax_tech_register(), ast_fax_tech_unregister(), ast_format_cache_set(), ast_format_def_unregister(), ast_frame_dump(), ast_image_register(), ast_image_unregister(), ast_jb_destroy(), ast_manager_register_struct(), ast_manager_unregister(), ast_merge_contexts_and_delete(), ast_module_reload(), ast_moh_destroy(), ast_moh_start(), ast_msg_handler_register(), ast_msg_handler_unregister(), ast_msg_tech_register(), ast_msg_tech_unregister(), ast_pbx_h_exten_run(), ast_realtime_append_mapping(), ast_record_review(), ast_register_application2(), ast_register_indication_country(), ast_rtp_engine_register2(), ast_rtp_engine_unregister(), ast_rtp_glue_register2(), ast_rtp_glue_unregister(), ast_rtp_ice_start_media(), ast_rtp_read(), ast_rtp_remote_address_set(), ast_say_enumeration_full_he(), ast_say_number_full_he(), ast_set_indication_country(), ast_set_priority(), ast_set_qos(), ast_sip_persistent_endpoint_update_state(), ast_sorcery_wizard_unregister(), ast_speech_register(), ast_speech_unregister(), ast_srtp_unprotect(), ast_streamfile(), ast_udptl_read(), ast_udptl_write(), ast_unload_resource(), ast_unregister_application(), ast_unregister_translator(), ast_websocket_close(), ast_websocket_server_add_protocol2(), ast_websocket_server_remove_protocol(), ast_websocket_uri_cb(), asterisk_daemon(), attempt_thread(), attempt_transfer(), auth_http_callback(), background_detect_exec(), begin_dial_channel(), blr_ebl(), blr_txt(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), bridge_exec(), bridge_parking_push(), bridgeadd_exec(), bridgewait_exec(), bridgewait_timeout_callback(), build_channels(), build_conf(), build_device(), build_gateway(), build_peer(), build_user(), caller_joined_bridge(), can_safely_quit(), chan_pjsip_cng_tone_detected(), channel_spy(), chanspy_exec(), check_for_conference(), check_send_queue(), cleanup_cb(), cli_console_mute(), close_call(), close_client(), close_rtp_connection(), close_udptl_connection(), comeback_goto(), conf_exec(), conf_run(), config_device(), config_line(), config_load(), config_odbc_prepare(), config_text_file_load(), configure_local_rtp(), console_answer(), console_call(), console_digit_begin(), console_digit_end(), console_hangup(), console_indicate(), console_text(), context_merge(), context_table_create_autohints(), control_streamfile(), copy_to_voicemail(), cpeid_exec(), create_client(), create_jb(), dahdi_dnd(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_hangup(), dahdi_read(), dahdi_restart(), dahdiras_exec(), database_increment(), debug_check_frame_for_silence(), delete_device(), deltree_exec(), destroy_all_channels(), dial_exec_full(), dialout(), do_discovery(), do_forward(), do_message(), do_monitor(), do_monitor_headset(), do_monitor_phone(), do_notify(), do_waiting(), dumpchan_exec(), eagi_exec(), eivr_comm(), exchangecal_write_event(), extensionstate_update(), fax_detect_framehook(), feature_attended_transfer(), feature_automixmonitor(), feature_automonitor(), feature_blind_transfer(), find_call(), find_conf_realtime(), find_friend(), find_peer(), find_subchannel_and_lock(), find_subchannel_by_name(), find_subline_by_name(), find_table(), find_transcoders(), find_user(), findmeexec(), flash_exec(), generic_fax_exec(), generic_http_callback(), get_avail_softkey(), get_folder(), get_to_address(), gosub_run(), grab_transfer(), handle_call_incoming(), handle_call_outgoing(), handle_cli_ooh323_reload(), handle_command_response(), handle_exec(), handle_frame(), handle_getoption(), handle_gosub(), handle_init_event(), handle_key_fav(), handle_message(), handle_offhook_message(), handle_request(), handle_response(), handle_response_ciev(), handle_response_cusd(), handle_response_error(), handle_response_info(), handle_response_message(), handle_response_no_carrier(), handle_response_no_dialtone(), handle_response_ok(), handle_soft_key_event_message(), handle_stimulus_message(), handle_streamfile(), handle_verbose(), iax2_ack_registry(), iax2_exec(), iax2_hangup(), iax2_key_rotate(), iax2_prov_app(), iax_firmware_reload(), iax_provision_reload(), init_files_class(), init_phone_step2(), isAnsweringMachine(), launch_script(), leave_voicemail(), length_determination_odbc_prepare(), listener(), load_config(), load_module(), load_modules(), load_pbx(), load_pjsip(), load_values_config(), log_events(), logger_print_normal(), lua_pbx_exec(), make_silence(), meetme_menu_admin_extended(), mgcp_answer(), mgcp_hangup(), mgcp_new(), mgcp_request(), mgcp_ss(), misdn_write(), mixmonitor_ds_close_fs(), mixmonitor_thread(), modules_shutdown(), moh_post_start(), moh_post_stop(), mwi_event_cb(), my_connect_db(), my_distinctive_ring(), my_handle_dtmf(), my_send_callerid(), native_rtp_bridge_start(), netconsole(), network_change_stasis_cb(), odbc_log(), onAlerting(), onCallCleared(), onCallEstablished(), onModeChanged(), onNewCallCreated(), onOutgoingCall(), onProgress(), ooh323_alloc(), ooh323_answer(), ooh323_call(), ooh323_delete_peer(), ooh323_destroy(), ooh323_digit_begin(), ooh323_digit_end(), ooh323_do_reload(), ooh323_fixup(), ooh323_get_codec(), ooh323_get_rtp_peer(), ooh323_hangup(), ooh323_indicate(), ooh323_new(), ooh323_onReceivedSetup(), ooh323_queryoption(), ooh323_request(), ooh323_rtp_read(), ooh323_set_read_format(), ooh323_set_rtp_peer(), ooh323_set_write_format(), ooh323c_set_capability(), ooh323c_set_capability_for_call(), page_exec(), parse_bookmark(), parse_config(), parse_register_contact(), parsing(), pbx_builtin_goto(), pbx_builtin_pushvar_helper(), pbx_builtin_setvar_helper(), pbx_builtin_waitexten(), pbx_extension_helper(), pbx_outgoing_exec(), pbx_outgoing_state_callback(), phone_hangup(), play_message_callerid(), play_record_review(), privacy_exec(), process_ast_dsp(), process_dahdi(), process_my_load_module(), process_request(), process_sdp(), prune_boot_contacts_cb(), purge_sessions(), push_callinfo(), queue_exec(), rcv_mac_addr(), rcv_resume_connection_with_server(), read_exec(), read_mf_exec(), read_sf_exec(), really_quit(), realtime_exec(), receive_ademco_event(), receive_dtmf_digits(), receivefax_exec(), refresh_all_favorite(), reg_source_db(), register_aor_core(), register_extension(), registrar_contact_delete(), reload(), reload_config(), reload_logger(), reload_module(), res_sdp_crypto_parse_offer(), res_srtp_init(), ring_entry(), rna(), rtp_reload(), run_agi(), run_ras(), say_periodic_announcement(), say_position(), send_blink_cursor(), send_callinfo(), send_charset_update(), send_client(), send_cursor_pos(), send_cwcidspill(), send_date_time(), send_date_time2(), send_date_time3(), send_dial_tone(), send_dtmf_tone(), send_end_call(), send_expansion_icon(), send_expansion_text(), send_favorite(), send_icon(), send_led_update(), send_month_labels(), send_mute(), send_no_ring(), send_ping(), send_raw_client(), send_retransmit(), send_ring(), send_select_output(), send_start_rtp(), send_start_timer(), send_stop_timer(), send_text(), send_text_status(), send_texttitle(), send_tone(), sendfax_exec(), session_destroy_fn(), session_do(), set_config(), set_priority_all(), setformat(), setsubstate(), setup_dahdi_int(), setup_park_common_datastore(), setup_privacy_args(), setup_rtp_connection(), setup_rtp_remote(), setup_udptl_connection(), sip_check_transport(), sip_options_contact_status_notify_task(), sip_options_remove_contact_status(), sip_options_set_contact_status(), sip_read(), sip_rtp_read(), skinny_newcall(), skinny_reload(), skinny_request(), skinny_session(), smart_bridge_operation(), smdi_load(), sms_debug(), sms_exec(), sms_handleincoming_proto2(), sms_process(), socket_process_helper(), softhangup_exec(), start_automixmonitor(), start_automonitor(), start_network_thread(), start_resource(), start_rtp(), start_spying(), stop_automixmonitor(), stop_automonitor(), store_config(), sub_start_silence(), sub_stop_silence(), swap_subs(), talk_detect_audiohook_cb(), timeout_write(), transfer_cancel_step2(), try_load_key(), try_merge_optimize_out(), try_suggested_sip_codec(), try_swap_optimize_out(), unbound_config_apply_default(), unistim_alloc_sub(), unistim_answer(), unistim_call(), unistim_do_senddigit(), unistim_hangup(), unistim_hangup_clean(), unistim_indicate(), unistim_new(), unistim_request(), unistim_senddigit_end(), unistim_sendtext(), unistim_ss(), unistimsock_read(), unload_module(), unregister_extension(), update_registry(), valid_priv_reply(), verbose_exec(), vm_authenticate(), vm_change_password(), vm_execmain(), vm_greeter_warn_no_provider(), vm_warn_no_provider(), wait_for_answer(), wait_for_digits(), wait_for_winner(), waitfor_exec(), waitforring_exec(), and write_metadata().

◆ ast_verb_callid

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

Value:

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

Definition at line 470 of file logger.h.

◆ ast_verbose

#define ast_verbose ( ... ) __ast_verbose(__FILE__, __LINE__, __PRETTY_FUNCTION__, -1, __VA_ARGS__)

Definition at line 177 of file logger.h.

◆ ast_verbose_callid

#define ast_verbose_callid	(	callid,
		...
	)	__ast_verbose_callid(__FILE__, __LINE__, __PRETTY_FUNCTION__, -1, callid, __VA_ARGS__)

Definition at line 178 of file logger.h.

Referenced by dahdi_cc_callback().

◆ 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 441 of file logger.h.

Referenced by __print_debug_details(), _ast_sockaddr_from_sin(), _ast_sockaddr_port(), _ast_sockaddr_set_port(), _ast_sockaddr_to_sin(), append_ha_core(), ast_add_extension2_lockopt(), ast_bridge_channel_queue_frame(), ast_rtp_interpret(), ast_sched_dump(), bridge_p2p_rtp_write(), callerid_feed_jp(), config_module(), dahdi_softhangup_all(), do_directory(), handle_client_registration(), log_caps(), matrix_rebuild(), parse_config(), process_my_load_module(), realtime_ldap_result_to_vars(), reregister_immediately_cb(), sendmail(), sip_dump_history(), sip_resolve_invoke_user_callback(), softmix_bridge_write_text(), tps_alert_add(), update2_ldap(), update_to_uri(), vm_allocate_dh(), and websocket_on_rx_msg().

◆ DEBUG_M

#define DEBUG_M ( a )

Value:

{ \
   a; \
}

Definition at line 37 of file logger.h.

◆ EVENTLOG

#define EVENTLOG "event_log"

Definition at line 34 of file logger.h.

◆ LOG_DEBUG

#define LOG_DEBUG __LOG_DEBUG, _A_

Definition at line 241 of file logger.h.

Referenced by __print_debug_details(), ast_add_extension2_lockopt(), ast_bridge_channel_queue_frame(), ast_http_get_auth(), ast_rtp_interpret(), ast_say_date_with_format_ja(), ast_sched_dump(), ast_sip_sched_task_cancel(), ast_sip_schedule_task(), ast_sip_session_create_joint_call_cap(), ast_sip_session_create_joint_call_stream(), ast_syslog_facility_name(), async_delete_name_rec_task(), beanstalk_put(), cel_bs_put(), check_header(), config_module(), debug_ha_sense_appended(), do_directory(), find_channel_control(), handle_client_registration(), matrix_rebuild(), parse_config(), process_my_load_module(), push_to_serializer(), realtime_ldap_result_to_vars(), reregister_immediately_cb(), run_task(), schtd_dtor(), sip_dump_history(), sip_resolve_invoke_user_callback(), softmix_bridge_write_text(), spandsp_log(), tps_alert_add(), update2_ldap(), vm_allocate_dh(), and websocket_on_rx_msg().

◆ LOG_DTMF

#define LOG_DTMF __LOG_DTMF, _A_

Definition at line 307 of file logger.h.

Referenced by __ast_read(), ast_channel_end_dtmf(), and bridge_channel_settle_owed_events().

◆ LOG_ERROR

#define LOG_ERROR __LOG_ERROR, _A_

Examples:: /usr/src/asterisk-18.5.0/main/app.c.

Definition at line 285 of file logger.h.

◆ LOG_NOTICE

#define LOG_NOTICE __LOG_NOTICE, _A_

Examples:: /usr/src/asterisk-18.5.0/main/app.c.

Definition at line 263 of file logger.h.

Referenced by __analog_handle_event(), __ast_request_and_dial(), __ast_udptl_reload(), __auto_congest(), __iax2_poke_noanswer(), __init_manager(), _extension_match_core(), _pgsql_exec(), accept_thread(), acf_curl_helper(), acf_jabberreceive_read(), acf_meetme_info(), acl_change_stasis_cb(), aco_option_find(), action_hangup(), add_in_calls(), add_notify(), add_out_calls(), admin_exec(), adsi_prog(), agents_sweep(), alsa_request(), alsa_write(), amihook_helper(), analog_handle_init_event(), analog_publish_channel_alarm_clear(), analog_ss_thread(), app_control_redirect(), app_exec(), append_ha_core(), aqm_exec(), ast_alaw_init(), ast_app_dtget(), ast_app_group_match_get_count(), ast_apply_acl_internal(), ast_ari_websocket_session_write(), ast_call_forward(), ast_channel_log(), ast_cli_perms_init(), ast_context_remove_extension_callerid2(), ast_decrypt_bin(), ast_encrypt_bin(), ast_io_remove(), ast_log_show_lock(), ast_named_acl_find(), ast_pickup_call(), ast_process_pending_reloads(), ast_queue_cc_frame(), ast_rtp_dtls_cfg_validate(), ast_rtp_ice_start(), ast_rtp_interpret(), ast_sip_initialize_resolver(), ast_sip_ouraddrfor(), ast_sip_retrieve_auths(), ast_syslog_facility_name(), ast_syslog_priority_from_loglevel(), ast_udptl_write(), ast_ulaw_init(), ast_xml_open(), attempt_thread(), auth_http_callback(), authenticate(), authenticate_reply(), authenticate_verify(), build_ami_notify(), build_peer(), callerid_feed(), callerid_feed_jp(), cb_events(), cc_esc_publish_handler(), cdr_enable_batch_mode(), cdr_object_update_party_b(), cdr_toggle_runtime_options(), chan_pjsip_cng_tone_detected(), channel_admin_exec(), chanspy_exec(), check_auth(), check_key(), check_rtp_timeout(), check_user_full(), cleanup_module(), compose_func_args(), config_device(), config_line(), config_load(), config_module(), config_odbc(), connected_line_method_handler(), console_request(), console_video_start(), control_tone_frame_response(), copy_header(), copy_via_headers(), cpg_confchg_cb(), cpg_deliver_cb(), create_dynamic_lot_full(), create_temp_file(), crement_function_read(), crypto_load(), dahdi_cc_callback(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_setoption(), db_open(), destroy_all_channels(), destroy_trans(), dial_exec_full(), direct_media_glare_mitigation_handler(), direct_media_method_handler(), dispatch_thread_handler(), dnsmgr_refresh(), do_autokill(), do_forward(), do_message_auth(), do_monitor(), do_register(), do_reload(), dump_queue(), dundi_encrypt(), dundi_exec(), dundi_helper(), dundi_precache_full(), dundi_precache_internal(), dundi_prop_precache(), dundi_rexmit(), dundi_send(), eivr_comm(), extenspy_exec(), fax_detect_framehook(), ffmpeg_decode(), find_account(), find_subchannel_and_lock(), find_subchannel_by_name(), finish_bookmark(), forward_message(), generate_parked_user(), get_canmatch_exten(), gosub_run(), group_count_function_read(), handle_call_outgoing(), handle_clear_alarms(), handle_cli_indication_add(), handle_command_response(), handle_gosub(), handle_incoming(), handle_init_event(), handle_message(), handle_missing_column(), handle_options(), handle_playtones(), handle_request(), handle_request_bye(), handle_request_invite(), handle_request_notify(), handle_request_refer(), handle_request_register(), handle_request_subscribe(), handle_response(), handle_response_invite(), handle_response_notify(), handle_response_peerpoke(), handle_response_publish(), handle_response_refer(), handle_response_register(), handle_response_subscribe(), handle_response_update(), iax2_canmatch(), iax2_exec(), iax2_exists(), iax2_matchmore(), iax2_poke_peer(), iax2_prov_app(), iax2_send(), iax_provision_reload(), idle_sched_cb(), import_ch(), ivr_dispatch(), jingle_action_hook(), jingle_indicate(), join_queue(), keepalive_global_loaded(), ldap_loadentry(), load_config(), load_config_meetme(), load_module(), load_modules(), load_odbc_config(), load_realtime_rules(), local_ast_moh_start(), local_call(), log_failed_request(), log_jack_status(), manager_isdn_handler(), mbl_load_config(), measurenoise(), meetmemute(), message_template_parse_emailbody(), mgcp_call(), mgcp_fixup(), mgcp_request(), mgcp_rtp_read(), mgcpsock_read(), misdn_hangup(), misdn_write(), mixmonitor_exec(), mkintf(), moh_parse_options(), monmp3thread(), mpeg4_decode(), msg_create_from_file(), mssql_connect(), mwi_thread(), my_handle_dtmf(), my_handle_notify_message(), my_on_hook(), nbs_request(), new_find_extension(), new_invite(), new_subscribe(), onModeChanged(), ooh323_convertAsteriskCapToH323Cap(), ooh323_request(), ooh323_rtp_read(), open_mailbox(), originate_exec(), oss_request(), parking_park_bridge_channel(), parse_bookmark(), parse_config(), parse_data(), parse_line(), parse_moved_contact(), parse_register_contact(), parsing(), pbx_extension_helper(), pbx_find_extension(), pbx_live_dangerously(), pbx_load_module(), pgsql_exec(), pgsql_log(), phone_request(), pickup_by_exten(), pickup_by_group(), pickup_exec(), pickupchan_exec(), playback_final_update(), playback_first_update(), process_ast_dsp(), process_cn_rfc3389(), process_config(), process_cors_request(), process_dahdi(), process_sdp(), publish_channel_alarm_clear(), publish_span_alarm_clear(), publish_to_corosync(), purge_old_messages(), qualify_contact_cb(), queue_function_qac_dep(), queue_multi_channel_to_ami(), read_password_from_file(), realtime_exec(), reg_source_db(), register_realtime_peers_with_callbackextens(), register_verify(), registry_rerequest(), reload(), reload_config(), reload_module(), reload_queue_members(), reload_queue_rules(), reload_queues(), res_sdp_crypto_parse_offer(), rqm_exec(), rtp_allocate_transport(), rtp_check_timeout(), scan_service(), send_check_user_failure_response(), set_caps(), set_config(), set_ulimit(), setup_dahdi_int(), setup_privacy_args(), sip_dump_history(), sip_msg_send(), sip_outbound_publish_callback(), sip_parse_host(), sip_parse_register_line(), sip_poke_noanswer(), sip_poke_peer(), sip_read(), sip_reg_timeout(), sip_request_call(), sip_reregister(), sipsock_read(), skinny_fixup(), skinny_indicate(), skinny_request(), skinny_session(), skinny_session_cleanup(), sla_station_exec(), smdi_load(), smoother_frame_feed(), sms_exec(), sms_messagerx2(), sms_process(), sms_readfile(), sms_writefile(), socket_process_helper(), softmix_mixing_array_grow(), softmix_mixing_array_init(), sorcery_config_internal_load(), sorcery_object_load(), srv_datastore_setup(), stasis_init(), stasis_message_type_declined(), stun_monitor_request(), stun_start_monitor(), stun_stop_monitor(), subscription_persistence_recreate(), system_exec_helper(), tdd_feed(), tds_load_module(), tds_log(), tds_message_handler(), test_state_changed(), testclient_exec(), testserver_exec(), timed_read(), transmit_refer(), transmit_register(), try_calling(), try_load_key(), udptl_pre_apply_config(), unistim_indicate(), unistim_request(), unistimsock_read(), update2_pgsql(), update2_prepare(), update_call_counter(), update_key(), update_pgsql(), update_registry(), update_scoreboard(), valid_priv_reply(), vars_to_headers(), vm_allocate_dh(), wait_for_answer(), wait_for_winner(), and waituntil_exec().

◆ LOG_TRACE

#define LOG_TRACE __LOG_TRACE, _A_

Definition at line 252 of file logger.h.

◆ LOG_VERBOSE

#define LOG_VERBOSE __LOG_VERBOSE, _A_

Definition at line 296 of file logger.h.

Referenced by __ast_str_helper().

◆ LOG_WARNING

#define LOG_WARNING __LOG_WARNING, _A_

Examples:: /usr/src/asterisk-18.5.0/main/app.c.

Definition at line 274 of file logger.h.

◆ NUMLOGLEVELS

#define NUMLOGLEVELS 32

Definition at line 314 of file logger.h.

Referenced by ast_console_toggle_loglevel().

◆ QUEUELOG

#define QUEUELOG "queue_log"

Definition at line 35 of file logger.h.

Referenced by init_logger_chain().

◆ SCOPE_ENTER

#define SCOPE_ENTER	(	level,
		...
	)

Non RAII_VAR Scope Trace macros The advantage of these macros is that the EXITs will have the actual line number where the scope exited. Much less code is required as well.

Scope Enter

Parameters

level	The trace level
(optional)	A printf style format string
(optional)	Arguments

Definition at line 780 of file logger.h.

Referenced by add_sdp_streams(), apply_negotiated_sdp_stream(), ast_channel_nativeformats_set(), ast_channel_set_stream_topology(), ast_sip_session_create_invite(), ast_sip_session_create_outgoing(), ast_sip_session_media_state_add(), ast_sip_session_regenerate_answer(), ast_sip_session_terminate(), ast_stream_create_resolved(), AST_TEST_DEFINE(), call(), chan_pjsip_answer(), chan_pjsip_call(), chan_pjsip_get_codec(), chan_pjsip_hangup(), chan_pjsip_incoming_ack(), chan_pjsip_incoming_request(), chan_pjsip_incoming_response(), chan_pjsip_incoming_response_update_cause(), chan_pjsip_indicate(), chan_pjsip_new(), chan_pjsip_request_with_stream_topology(), chan_pjsip_session_begin(), chan_pjsip_session_end(), chan_pjsip_set_rtp_peer(), compatible_formats_exist(), create_local_sdp(), create_outgoing_sdp_stream(), delay_request(), dial_exec_full(), generate_session_refresh_sdp(), get_codecs(), handle_incoming_request(), handle_incoming_response(), handle_incoming_sdp(), handle_negotiated_sdp(), handle_negotiated_sdp_session_media(), handle_new_invite_request(), handle_outgoing_request(), handle_outgoing_response(), handle_topology_request_change(), hangup(), invite_collision_timeout(), invite_proceeding(), invite_terminated(), is_media_state_valid(), negotiate_incoming_sdp_stream(), new_invite(), on_topology_change_response(), pbx_start_incoming_request(), request(), reschedule_reinvite(), resolve_refresh_media_states(), send_delayed_request(), send_topology_change_refresh(), session_inv_on_media_update(), session_inv_on_rx_offer(), session_inv_on_state_changed(), session_inv_on_tsx_state_changed(), session_on_rx_request(), session_on_rx_response(), session_on_tsx_state(), set_caps(), set_incoming_call_offer_cap(), sfu_topologies_on_join(), sip_session_refresh(), softmix_bridge_join(), softmix_bridge_stream_sources_update(), softmix_bridge_stream_topology_changed(), test_is_media_state_equal(), test_scope_enter_function(), test_scope_trace(), and wait_for_answer().

◆ SCOPE_ENTER_TASK

#define SCOPE_ENTER_TASK	(	level,
		indent,
		...
	)

Definition at line 788 of file logger.h.

Referenced by answer().

◆ SCOPE_EXIT

#define SCOPE_EXIT ( ... )

Scope Exit.

Parameters

(optional)	A printf style format string
(optional)	Arguments

This macro can be used at the exit points of a statement block since it just prints the message.

Definition at line 805 of file logger.h.

Referenced by AST_TEST_DEFINE(), create_local_sdp(), handle_incoming_request(), handle_incoming_response(), handle_incoming_sdp(), handle_new_invite_request(), handle_outgoing_request(), handle_outgoing_response(), is_media_state_valid(), resolve_refresh_media_states(), sfu_topologies_on_join(), sip_session_refresh(), and softmix_bridge_stream_sources_update().

◆ SCOPE_EXIT_EXPR

#define SCOPE_EXIT_EXPR	(	__expr,
		...
	)

Definition at line 834 of file logger.h.

Referenced by AST_TEST_DEFINE(), create_local_sdp(), handle_incoming_sdp(), is_media_state_valid(), resolve_refresh_media_states(), sip_session_refresh(), and softmix_bridge_stream_sources_update().

◆ SCOPE_EXIT_LOG

#define SCOPE_EXIT_LOG	(	__log_level,
		...
	)

Value:

({ \
   ast_log(__log_level, " " __VA_ARGS__); \
   SCOPE_EXIT(" " __VA_ARGS__); \
})

The following macros will print log messages before running the associated SCOPE_ macro.

Definition at line 928 of file logger.h.

Referenced by softmix_bridge_stream_sources_update().

◆ SCOPE_EXIT_LOG_EXPR

#define SCOPE_EXIT_LOG_EXPR	(	__expr,
		__log_level,
		...
	)

Value:

({ \
   ast_log(__log_level, " " __VA_ARGS__); \
   SCOPE_EXIT_EXPR(__expr, " " __VA_ARGS__); \
})

Definition at line 946 of file logger.h.

Referenced by create_local_sdp(), handle_incoming_sdp(), and sip_session_refresh().

◆ SCOPE_EXIT_LOG_RTN

#define SCOPE_EXIT_LOG_RTN	(	__log_level,
		...
	)

Value:

({ \
   ast_log(__log_level, " " __VA_ARGS__); \
   SCOPE_EXIT_RTN(" " __VA_ARGS__); \
})

Definition at line 934 of file logger.h.

Referenced by handle_outgoing_response(), reschedule_reinvite(), and sfu_topologies_on_join().

◆ SCOPE_EXIT_LOG_RTN_VALUE

#define SCOPE_EXIT_LOG_RTN_VALUE	(	__value,
		__log_level,
		...
	)

Value:

({ \
   ast_log(__log_level, " " __VA_ARGS__); \
   SCOPE_EXIT_RTN_VALUE(__value, " " __VA_ARGS__); \
})

Definition at line 940 of file logger.h.

Referenced by chan_pjsip_incoming_request(), chan_pjsip_indicate(), create_local_sdp(), delay_request(), handle_incoming_sdp(), resolve_refresh_media_states(), send_delayed_request(), and sip_session_refresh().

◆ SCOPE_EXIT_RTN

#define SCOPE_EXIT_RTN ( ... )

Scope Exit with return.

Parameters

(optional)	A printf style format string
(optional)	Arguments

This macro can be used at the exit points of a function when no value needs to be returned.

Definition at line 854 of file logger.h.

Referenced by ast_channel_nativeformats_set(), ast_sip_session_terminate(), chan_pjsip_get_codec(), chan_pjsip_incoming_response(), chan_pjsip_incoming_response_update_cause(), chan_pjsip_session_begin(), chan_pjsip_session_end(), get_codecs(), handle_new_invite_request(), reschedule_reinvite(), session_inv_on_media_update(), session_inv_on_rx_offer(), session_inv_on_state_changed(), session_inv_on_tsx_state_changed(), session_on_tsx_state(), softmix_bridge_stream_topology_changed(), and test_scope_trace().

◆ SCOPE_EXIT_RTN_VALUE

#define SCOPE_EXIT_RTN_VALUE	(	__return_value,
		...
	)

Scope Exit with return value.

Parameters

__return_value	The return value
(optional)	A printf style format string
(optional)	Arguments

This macro can be used at the exit points of a function when a value needs to be returned.

Definition at line 875 of file logger.h.

Referenced by add_sdp_streams(), answer(), apply_negotiated_sdp_stream(), ast_channel_set_stream_topology(), ast_sip_session_create_invite(), ast_sip_session_create_outgoing(), ast_sip_session_media_state_add(), ast_sip_session_regenerate_answer(), ast_stream_create_resolved(), AST_TEST_DEFINE(), call(), chan_pjsip_answer(), chan_pjsip_call(), chan_pjsip_hangup(), chan_pjsip_incoming_ack(), chan_pjsip_incoming_request(), chan_pjsip_indicate(), chan_pjsip_new(), chan_pjsip_request_with_stream_topology(), chan_pjsip_set_rtp_peer(), compatible_formats_exist(), create_local_sdp(), create_outgoing_sdp_stream(), delay_request(), dial_exec_full(), generate_session_refresh_sdp(), handle_incoming_sdp(), handle_negotiated_sdp(), handle_negotiated_sdp_session_media(), handle_topology_request_change(), hangup(), invite_collision_timeout(), invite_proceeding(), invite_terminated(), is_media_state_valid(), negotiate_incoming_sdp_stream(), new_invite(), on_topology_change_response(), pbx_start_incoming_request(), request(), resolve_refresh_media_states(), send_delayed_request(), send_topology_change_refresh(), session_on_rx_request(), session_on_rx_response(), set_caps(), set_incoming_call_offer_cap(), sip_session_refresh(), softmix_bridge_join(), test_is_media_state_equal(), test_scope_enter_function(), and wait_for_answer().

◆ SCOPE_TRACE

#define SCOPE_TRACE	(	level,
		...
	)

Print a trace message with details when a scope is entered or existed.

Parameters

level	The trace level
(optional)	A printf style format string
(optional)	Arguments

This will print the file, line and function plus details at the current indent level.

Note: Like RAII_VAR, this macro must be called before any code in the scope.; The variables used to detect scope change will look like __scopevar1234__EXIT and __scopevar1234__ENTER. The ENTER variable and function are needed to prevent mixed code and declaration issues. If we simple called __ast_trace, then this macro would need to be the last line of scope variable declaration. The following would fail.

SCOPE_TRACE(1, "Help!\n"); int i;

Definition at line 749 of file logger.h.

Referenced by __ast_answer(), ast_answer(), ast_bridge_call_with_flags(), ast_bridge_depart(), ast_bridge_impart(), ast_bridge_join(), ast_raw_answer_with_stream_topology(), AST_TEST_DEFINE(), and pre_bridge_setup().

◆ TRACE_ATLEAST

#define TRACE_ATLEAST ( level )

Value:

(option_trace >= (level) \
      || (ast_opt_trace_module \
         && ((int)ast_trace_get_by_module(AST_MODULE) >= (level) \
            || (int)ast_trace_get_by_module(__FILE__) >= (level))))

Definition at line 637 of file logger.h.

Referenced by ast_stream_create_resolved(), handle_new_invite_request(), and session_on_rx_request().

◆ VERBOSE_HASMAGIC

#define VERBOSE_HASMAGIC ( x ) (*(signed char *) (x) < 0)

Definition at line 193 of file logger.h.

Referenced by console_print().

◆ VERBOSE_MAGIC2LEVEL

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

Definition at line 192 of file logger.h.

Referenced by console_print().

◆ VERBOSE_PREFIX_1

#define VERBOSE_PREFIX_1 " "

Definition at line 41 of file logger.h.

Referenced by logger_add_verbose_magic(), and set_header().

◆ VERBOSE_PREFIX_2

#define VERBOSE_PREFIX_2 " == "

Definition at line 42 of file logger.h.

Referenced by logger_add_verbose_magic(), and set_header().

◆ VERBOSE_PREFIX_3

#define VERBOSE_PREFIX_3 " -- "

Definition at line 43 of file logger.h.

Referenced by logger_add_verbose_magic(), and set_header().

◆ VERBOSE_PREFIX_4

#define VERBOSE_PREFIX_4 " > "

Definition at line 44 of file logger.h.

Referenced by logger_add_verbose_magic(), set_header(), and socket_process_helper().

◆ VERBOSITY_ATLEAST

#define VERBOSITY_ATLEAST ( level ) ((level) <= ast_verb_sys_level)

Definition at line 461 of file logger.h.

Referenced by ast_streamfile(), dumpchan_exec(), pbx_extension_helper(), purge_sessions(), registrar_contact_delete(), and timeout_write().

Typedef Documentation

◆ ast_callid

typedef unsigned int ast_callid

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 87 of file 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 48 of file 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 */
 };

◆ ast_trace_indent_type

enum ast_trace_indent_type

Controls if and when indenting is applied.

Enumerator
AST_TRACE_INDENT_SAME	Use the existing indent level
AST_TRACE_INDENT_INC_BEFORE	Increment the indent before printing the message
AST_TRACE_INDENT_INC_AFTER	Increment the indent after printing the message
AST_TRACE_INDENT_DEC_BEFORE	Decrement the indent before printing the message
AST_TRACE_INDENT_DEC_AFTER	Decrement the indent after printing the message
AST_TRACE_INDENT_PROVIDED	Set the indent to the one provided
AST_TRACE_INDENT_NONE	Don't use or alter the level

Definition at line 646 of file logger.h.

                            {
    /*! Use the existing indent level */
    AST_TRACE_INDENT_SAME = 0,
    /*! Increment the indent before printing the message */
    AST_TRACE_INDENT_INC_BEFORE,
    /*! Increment the indent after printing the message */
    AST_TRACE_INDENT_INC_AFTER,
    /*! Decrement the indent before printing the message */
    AST_TRACE_INDENT_DEC_BEFORE,
    /*! Decrement the indent after printing the message */
    AST_TRACE_INDENT_DEC_AFTER,
    /*! Set the indent to the one provided */
    AST_TRACE_INDENT_PROVIDED,
    /*! Don't use or alter the level */
    AST_TRACE_INDENT_NONE,
 };

Function Documentation

◆ __ast_trace()

void __ast_trace	(	const char *	file,
		int	line,
		const char *	func,
		enum ast_trace_indent_type	indent_type,
		unsigned long	indent,
		const char *	format,
			...
	)

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2405 of file logger.c.

References __LOG_TRACE, ast_free, ast_log_full(), ast_skip_blanks(), ast_str_buffer(), ast_str_create, ast_str_set(), ast_threadstorage_get_ptr(), ast_threadstorage_set_ptr(), AST_TRACE_INDENT_DEC_AFTER, AST_TRACE_INDENT_DEC_BEFORE, AST_TRACE_INDENT_INC_AFTER, AST_TRACE_INDENT_INC_BEFORE, AST_TRACE_INDENT_NONE, AST_TRACE_INDENT_PROVIDED, AST_TRACE_INDENT_SAME, LOTS_O_SPACES, NULL, and S_OR.

 {
    va_list ap;
    unsigned long indent = (unsigned long)ast_threadstorage_get_ptr(&trace_indent);
    struct ast_str *fmt = ast_str_create(128);
    const char *direction = "";
 
    if (!fmt) {
       return;
    }
 
    if (indent_type == AST_TRACE_INDENT_PROVIDED) {
       indent = new_indent;
       ast_threadstorage_set_ptr(&trace_indent, (void*)indent);
    } else if (indent_type == AST_TRACE_INDENT_INC_BEFORE) {
       indent++;
       ast_threadstorage_set_ptr(&trace_indent, (void*)indent);
    } else if (indent_type == AST_TRACE_INDENT_DEC_BEFORE) {
       indent--;
       ast_threadstorage_set_ptr(&trace_indent, (void*)indent);
    }
 
    switch(indent_type) {
    case AST_TRACE_INDENT_NONE:
    case AST_TRACE_INDENT_SAME:
       direction = "";
       break;
    case AST_TRACE_INDENT_INC_BEFORE:
    case AST_TRACE_INDENT_INC_AFTER:
    case AST_TRACE_INDENT_PROVIDED:
       direction = "--> ";
       break;
    case AST_TRACE_INDENT_DEC_BEFORE:
    case AST_TRACE_INDENT_DEC_AFTER:
       direction = "<-- ";
       break;
    }
 
    ast_str_set(&fmt, 0, "%2d %-.*s%s%s:%d %s: %s", (int)indent, (indent_type == AST_TRACE_INDENT_NONE ? 0 : (int)(indent * 4)),
       LOTS_O_SPACES, direction, file, line, func, S_OR(ast_skip_blanks(format), "\n"));
 
    if (indent_type == AST_TRACE_INDENT_INC_AFTER || indent_type == AST_TRACE_INDENT_PROVIDED) {
       indent++;
       ast_threadstorage_set_ptr(&trace_indent, (void*)indent);
    }
    if (indent_type == AST_TRACE_INDENT_DEC_AFTER) {
       indent--;
       ast_threadstorage_set_ptr(&trace_indent, (void*)indent);
    }
 
    va_start(ap, format);
    ast_log_full(__LOG_TRACE, -1, NULL, 0, NULL, 0, ast_str_buffer(fmt), ap);
    va_end(ap);
    ast_free(fmt);
 }

◆ __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_4 are defined.

Version: 11 added level parameter

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2198 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);
 }

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2193 of file logger.c.

References __LOG_VERBOSE, and ast_log_full().

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

 {
    ast_log_full(__LOG_VERBOSE, level, file, line, func, callid, fmt, 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.

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2210 of file logger.c.

References __ast_verbose_ap().

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

◆ _ast_trace_dec_indent()

unsigned long _ast_trace_dec_indent ( void )

Decrement the indent level.

Returns: The new indent level

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2396 of file logger.c.

References ast_threadstorage_get_ptr(), and ast_threadstorage_set_ptr().

 {
    unsigned long indent = (unsigned long)ast_threadstorage_get_ptr(&trace_indent);
    indent--;
    ast_threadstorage_set_ptr(&trace_indent, (void*)indent);
 
    return indent;
 }

◆ _ast_trace_get_indent()

unsigned long _ast_trace_get_indent ( void )

Get the current indent level.

Returns: The current indent level

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2377 of file logger.c.

References ast_threadstorage_get_ptr().

 {
    return (unsigned long)ast_threadstorage_get_ptr(&trace_indent);
 }

◆ _ast_trace_inc_indent()

unsigned long _ast_trace_inc_indent ( void )

Increment the indent level.

Returns: The new indent level

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2387 of file logger.c.

References ast_threadstorage_get_ptr(), and ast_threadstorage_set_ptr().

 {
    unsigned long indent = (unsigned long)ast_threadstorage_get_ptr(&trace_indent);
    indent++;
    ast_threadstorage_set_ptr(&trace_indent, (void*)indent);
 
    return indent;
 }

◆ _ast_trace_set_indent()

void _ast_trace_set_indent ( unsigned long indent )

Set the current indent level.

Parameters

indent The new indent level

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2382 of file logger.c.

References ast_threadstorage_set_ptr().

 {
    ast_threadstorage_set_ptr(&trace_indent, (void*)indent);
 }

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1952 of file logger.c.

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

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

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1984 of file logger.c.

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(), handle_request_do(), jingle_action_hook(), jingle_outgoing_hook(), mixmonitor_thread(), socket_process_helper(), and softmix_mixing_thread().

 {
    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;
 }

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1971 of file logger.c.

References ast_threadstorage_get(), and unique_callid.

Referenced by autoservice_run(), and bridge_manager_service().

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

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2003 of file logger.c.

References ast_threadstorage_get(), and unique_callid.

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

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

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2020 of file logger.c.

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_clear_alarms(), handle_init_event(), mwi_thread(), my_new_analog_ast_channel(), and my_on_hook().

 {
    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;
 }

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2042 of file logger.c.

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_clear_alarms(), handle_init_event(), and mwi_thread().

 {
    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();
    }
 }

◆ ast_child_verbose()

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 850 of file logger.c.

References ast_free, ast_malloc, and NULL.

Referenced by launch_script().

 {
    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);
 }

◆ ast_console_puts()

void ast_console_puts ( const char * string )

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1314 of file asterisk.c.

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

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1274 of file asterisk.c.

References ast_console_puts_mutable_full(), and console_print().

Referenced by init_logger_chain(), and make_logchannel().

 {
    ast_console_puts_mutable_full(string, level, 0);
 }

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1281 of file asterisk.c.

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

 {
    /* 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);
 }

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1209 of file asterisk.c.

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

Referenced by handle_logger_set_level().

 {
    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;
       }
    }
 }

◆ ast_console_toggle_mute()

void ast_console_toggle_mute	(	int	fd,
		int	silent
	)

mute or unmute a console from logging

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1232 of file asterisk.c.

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

Referenced by handle_logger_mute().

 {
    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");
 }

◆ ast_create_callid()

ast_callid ast_create_callid ( void )

factory function to create a new uniquely identifying callid.

Return values

The call id

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1957 of file logger.c.

References ast_atomic_fetchadd_int(), and next_unique_callid.

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

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

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

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

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

 {
    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;
 }

◆ ast_dynamic_logger_level()

int ast_dynamic_logger_level ( const char * name )

Checks if a dynamic logger level exists.

Parameters

name	The name of the dynamic level for which to check existence

Return values

-1	if no such dynamic level exists
non-zero	negative to be used with ast_log_dynamic_level for sending messages to this level

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2514 of file logger.c.

References ARRAY_LEN, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by log_exec().

 {
    int level = -1;
    unsigned int x;
 
    AST_RWLIST_WRLOCK(&logchannels);
 
    for (x = 16; x < ARRAY_LEN(levels); x++) {
       if (!levels[x]) {
          continue;
       }
       if (!strcasecmp(levels[x], name)) {
          level = x;
          break;
       }
    }
 
    AST_RWLIST_UNLOCK(&logchannels);
 
    return level;
 }

◆ ast_init_logger_for_socket_console()

void ast_init_logger_for_socket_console ( void )

load logger.conf configuration for console socket connections

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 684 of file logger.c.

References ast_config_destroy(), ast_config_load2(), ast_copy_string(), ast_variable_retrieve(), CONFIG_STATUS_FILEINVALID, and dateformat.

Referenced by ast_remotecontrol().

 {
    struct ast_config *cfg;
    const char *s;
    struct ast_flags config_flags = { 0 };
 
    if (!(cfg = ast_config_load2("logger.conf", "logger", config_flags)) || cfg == CONFIG_STATUS_FILEINVALID) {
       return;
    }
 
    if ((s = ast_variable_retrieve(cfg, "general", "dateformat"))) {
       ast_copy_string(dateformat, s, sizeof(dateformat));
    }
 
    ast_config_destroy(cfg);
 }

◆ ast_is_logger_initialized()

int ast_is_logger_initialized ( void )

Test if logger is initialized.

Return values

true	if the logger is initialized

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1841 of file logger.c.

References logger_initialized.

Referenced by check_init().

 {
    return logger_initialized;
 }

◆ 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.

References ast_log_ap(), check_eval(), check_expr(), context, exten, find_var(), parse_file(), pbx_find_extension(), set_var(), varz::varname, and varz::varval.

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

 {
            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);
 }

◆ ast_log_ap()

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2110 of file logger.c.

References __ast_verbose_ap(), __LOG_VERBOSE, ast_log_full(), ast_read_threadstorage_callid(), and logmsg::callid.

Referenced by ast_log(), and module_load_error().

 {
    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);
    }
 }

◆ ast_log_backtrace()

void ast_log_backtrace ( void )

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2158 of file logger.c.

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

 {
 #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) */
 }

◆ 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? :-)

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2149 of file logger.c.

References ast_log_full().

Referenced by ast_channel_destructor(), and dahdi_cc_callback().

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

◆ 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.

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2123 of file logger.c.

References ast_log_full(), ast_read_threadstorage_callid(), ast_threadstorage_get_ptr(), ast_threadstorage_set_ptr(), logmsg::callid, and NULL.

Referenced by __ast_str_helper(), and ast_log_backtrace().

 {
    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, (void*)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);
 }

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1419 of file logger.c.

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

 {
    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;
 }

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1336 of file logger.c.

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, logchannel::logmask, LOGTYPE_CONSOLE, LOGTYPE_SYSLOG, NULL, and logchannel::type.

Referenced by ast_ari_asterisk_list_log_channels().

 {
    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;
 }

◆ ast_logger_get_dateformat()

const char* ast_logger_get_dateformat ( void )

Get the logger configured date format.

Return values

The	date format string

Since: 13.0.0

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2577 of file logger.c.

References dateformat.

Referenced by set_header().

 {
    return dateformat;
 }

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2587 of file logger.c.

References logger_queue_limit.

Referenced by handle_cli_queue_test().

 {
    return logger_queue_limit;
 }

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2503 of file logger.c.

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

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

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

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1485 of file logger.c.

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

 {
    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;
 }

◆ ast_logger_rotate()

int ast_logger_rotate ( void )

Reload logger while rotating log files.

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1254 of file logger.c.

References NULL, and reload_logger().

Referenced by action_loggerrotate().

 {
    return reload_logger(1, NULL);
 }

◆ 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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1259 of file logger.c.

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

 {
    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;
 }

◆ 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

Returns: Nothing

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2582 of file logger.c.

References logger_queue_limit.

Referenced by handle_cli_queue_test().

 {
    logger_queue_limit = queue_limit;
 }

◆ 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

Returns: nothing

Since: 1.8

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2536 of file logger.c.

References ARRAY_LEN, ast_debug, ast_free, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, global_logmask, NULL, and update_logchannels().

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

 {
    unsigned int found = 0;
    unsigned int x;
 
    AST_RWLIST_WRLOCK(&logchannels);
 
    for (x = 16; x < ARRAY_LEN(levels); x++) {
       if (!levels[x]) {
          continue;
       }
 
       if (strcasecmp(levels[x], name)) {
          continue;
       }
 
       found = 1;
       break;
    }
 
    if (found) {
       /* take this level out of the global_logmask, to ensure that no new log messages
        * will be queued for it
        */
 
       global_logmask &= ~(1 << x);
 
       ast_free(levels[x]);
       levels[x] = NULL;
       AST_RWLIST_UNLOCK(&logchannels);
 
       ast_debug(1, "Unregistered dynamic logger level '%s' with index %u.\n", name, x);
 
       AST_RWLIST_WRLOCK(&logchannels);
       update_logchannels();
       AST_RWLIST_UNLOCK(&logchannels);
    } else {
       AST_RWLIST_UNLOCK(&logchannels);
    }
 }

◆ ast_queue_log()

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 894 of file logger.c.

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

 {
    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);
    }
 }

◆ ast_read_threadstorage_callid()

ast_callid ast_read_threadstorage_callid ( void )

extracts the callerid from the thread

Return values

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 1962 of file logger.c.

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(), common_recall_channel_setup(), iax2_request(), jingle_alloc(), launch_monitor_thread(), local_request_with_stream_topology(), media_request_helper(), sip_request_call(), and socket_process().

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

◆ ast_register_verbose()

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

◆ ast_trace_get_by_module()

unsigned int ast_trace_get_by_module ( const char * module )

Get the trace level for a module.

Parameters

module the name of module

Returns: the trace level

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

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

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

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

◆ ast_unregister_verbose()

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

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

◆ ast_verb_console_get()

int ast_verb_console_get ( void )

Get this thread's console verbosity level.

Return values

verbosity level of the console.

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2323 of file logger.c.

References AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_threadstorage_get(), verb_console::level, my_verb_console, and option_verbose.

Referenced by handle_show_settings(), and handle_verbose().

 {
    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;
 }

◆ 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.

Returns: Nothing

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2296 of file logger.c.

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

 {
    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();
 }

◆ 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.

Returns: Nothing

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2341 of file logger.c.

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

Referenced by handle_verbose().

 {
    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();
 }

◆ ast_verb_console_unregister()

void ast_verb_console_unregister ( void )

Unregister this thread's console verbosity level.

Returns: Nothing

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2312 of file logger.c.

References ast_threadstorage_get(), my_verb_console, and verb_console_unregister().

Referenced by netconsole().

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

◆ ast_verb_update()

void ast_verb_update ( void )

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

Returns: Nothing

Examples:: /usr/src/asterisk-18.5.0/include/asterisk/logger.h.

Definition at line 2232 of file logger.c.

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

 {
    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);
 }

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ __LOG_DEBUG

◆ __LOG_DTMF

◆ __LOG_ERROR

◆ __LOG_NOTICE

◆ __LOG_TRACE

◆ __LOG_VERBOSE

◆ __LOG_WARNING

◆ _A_

◆ AST_CALLID_BUFFER_LENGTH

◆ ast_debug

◆ AST_LOG_DEBUG

◆ AST_LOG_DTMF

◆ ast_log_dynamic_level

◆ AST_LOG_ERROR

◆ AST_LOG_NOTICE

◆ AST_LOG_TRACE

◆ AST_LOG_VERBOSE

◆ AST_LOG_WARNING

◆ ast_trace

◆ ast_trace_dec_indent

◆ ast_trace_get_indent

◆ ast_trace_inc_indent

◆ ast_trace_log

◆ ast_trace_raw

◆ ast_trace_set_indent

◆ ast_verb

◆ ast_verb_callid

◆ ast_verbose

◆ ast_verbose_callid

◆ DEBUG_ATLEAST

◆ DEBUG_M

◆ EVENTLOG

◆ LOG_DEBUG

◆ LOG_DTMF

◆ LOG_ERROR

◆ LOG_NOTICE

◆ LOG_TRACE

◆ LOG_VERBOSE

◆ LOG_WARNING

◆ NUMLOGLEVELS

◆ QUEUELOG

◆ SCOPE_ENTER

◆ SCOPE_ENTER_TASK

◆ SCOPE_EXIT

◆ SCOPE_EXIT_EXPR

◆ SCOPE_EXIT_LOG

◆ SCOPE_EXIT_LOG_EXPR

◆ SCOPE_EXIT_LOG_RTN

◆ SCOPE_EXIT_LOG_RTN_VALUE

◆ SCOPE_EXIT_RTN

◆ SCOPE_EXIT_RTN_VALUE

◆ SCOPE_TRACE

◆ TRACE_ATLEAST

◆ VERBOSE_HASMAGIC

◆ VERBOSE_MAGIC2LEVEL

◆ VERBOSE_PREFIX_1

◆ VERBOSE_PREFIX_2

◆ VERBOSE_PREFIX_3

◆ VERBOSE_PREFIX_4

◆ VERBOSITY_ATLEAST

Typedef Documentation

◆ ast_callid

Enumeration Type Documentation

◆ ast_logger_results

◆ ast_trace_indent_type

Function Documentation

◆ __ast_trace()

◆ __ast_verbose()

◆ __ast_verbose_ap()

◆ __ast_verbose_callid()

◆ _ast_trace_dec_indent()

◆ _ast_trace_get_indent()

◆ _ast_trace_inc_indent()