utils.h File Reference

Utility functions. More...

#include "asterisk/network.h"
#include <time.h>
#include <unistd.h>
#include "asterisk/lock.h"
#include "asterisk/logger.h"
#include "asterisk/localtime.h"
#include "asterisk/strings.h"

Include dependency graph for utils.h:

Go to the source code of this file.

Data Structures
struct	ast_eid
	An Entity ID is essentially a MAC address, brief and unique. More...
struct	ast_flags
	Structure used to handle boolean flags. More...
struct	ast_flags64
	Structure used to handle a large number of boolean flags == used only in app_dial? More...
struct	ast_hostent
Defines
#define	ARRAY_LEN(a)   (sizeof(a) / sizeof(0[a]))
#define	ast_assert(a)
#define	AST_BACKGROUND_STACKSIZE   AST_STACKSIZE
#define	ast_clear_flag(p, flag)
#define	ast_clear_flag64(p, flag)
#define	ast_clear_flag_nonstd(p, flag)
#define	ast_copy_flags(dest, src, flagz)
#define	ast_copy_flags64(dest, src, flagz)
#define	ast_copy_flags_nonstd(dest, src, flagz)
#define	AST_FLAGS_ALL   UINT_MAX
#define	ast_pthread_create(a, b, c, d)
#define	ast_pthread_create_background(a, b, c, d)
#define	ast_pthread_create_detached(a, b, c, d)
#define	ast_pthread_create_detached_background(a, b, c, d)
#define	ast_set2_flag(p, value, flag)
#define	ast_set2_flag64(p, value, flag)
#define	ast_set2_flag_nonstd(p, value, flag)
#define	ast_set_flag(p, flag)
#define	ast_set_flag64(p, flag)
#define	ast_set_flag_nonstd(p, flag)
#define	ast_set_flags_to(p, flag, value)
#define	ast_set_flags_to64(p, flag, value)
#define	AST_STACKSIZE   (((sizeof(void *) * 8 * 8) - 16) * 1024)
#define	ast_strdupa(s)
	duplicate a string in memory from the stack
#define	ast_test_flag(p, flag)
#define	ast_test_flag64(p, flag)
#define	ast_test_flag_nonstd(p, flag)   ((p)->flags & (flag))
#define	localtime_r   __dont_use_localtime_r_use_ast_localtime_instead__
#define	MAX(a, b)   ({ typeof(a) __a = (a); typeof(b) __b = (b); ((__a < __b) ? __b : __a);})
#define	MIN(a, b)   ({ typeof(a) __a = (a); typeof(b) __b = (b); ((__a > __b) ? __b : __a);})
Functions
int	ast_base64decode (unsigned char *dst, const char *src, int max)
	Decode data from base64.
int	ast_base64encode (char *dst, const unsigned char *src, int srclen, int max)
	Encode data in base64.
int	ast_base64encode_full (char *dst, const unsigned char *src, int srclen, int max, int linebreaks)
	encode text to BASE64 coding
int	ast_careful_fwrite (FILE *f, int fd, const char *s, size_t len, int timeoutms)
	Write data to a file stream with a timeout.
int	ast_carefulwrite (int fd, char *s, int len, int timeoutms)
	Try to write string, but wait no more than ms milliseconds before timing out.
int	ast_eid_cmp (const struct ast_eid *eid1, const struct ast_eid *eid2)
	Compare two EIDs.
char *	ast_eid_to_str (char *s, int maxlen, struct ast_eid *eid)
void	ast_enable_packet_fragmentation (int sock)
	Disable PMTU discovery on a socket.
static void	ast_free_ptr (void *ptr) attribute_unused
	free() wrapper
struct hostent *	ast_gethostbyname (const char *host, struct ast_hostent *hp)
	Thread-safe gethostbyname function to use in Asterisk.
void	ast_md5_hash (char *output, char *input)
	Produces MD5 hash based on input string.
int	ast_mkdir (const char *path, int mode)
	Recursively create directory path.
char *	ast_process_quotes_and_slashes (char *start, char find, char replace_with)
	Process a string to find and replace characters.
int	ast_pthread_create_detached_stack (pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *), void *data, size_t stacksize, const char *file, const char *caller, int line, const char *start_fn)
int	ast_pthread_create_stack (pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *), void *data, size_t stacksize, const char *file, const char *caller, int line, const char *start_fn)
long int	ast_random (void)
void	ast_register_thread (char *name)
void	ast_set_default_eid (struct ast_eid *eid)
	Fill in an ast_eid with the default eid of this machine.
void	ast_sha1_hash (char *output, char *input)
	Produces SHA1 hash based on input string.
static force_inline void	ast_slinear_saturated_add (short *input, short *value)
static force_inline void	ast_slinear_saturated_divide (short *input, short *value)
static force_inline void	ast_slinear_saturated_multiply (short *input, short *value)
static force_inline void	ast_slinear_saturated_subtract (short *input, short *value)
int	ast_str_to_eid (struct ast_eid *eid, const char *s)
	Convert a string into an EID.
void	ast_unregister_thread (void *id)
void	ast_uri_decode (char *s)
	Decode URI, URN, URL (overwrite string).
char *	ast_uri_encode (const char *string, char *outbuf, int buflen, int doreserved)
	Turn text string to URI-encoded XX version.
int	ast_utils_init (void)
int	ast_wait_for_input (int fd, int ms)
Variables
unsigned int	__unsigned_int_flags_dummy
uint64_t	__unsigned_int_flags_dummy64
struct ast_eid	ast_eid_default
	Global EID.

---

Detailed Description

Utility functions.

Definition in file utils.h.

---

Define Documentation

#define ARRAY_LEN

(

a

)

(sizeof(a) / sizeof(0[a]))

Definition at line 652 of file utils.h.

Referenced by __ast_cli_generator(), __unload_module(), _sip_show_peer(), ais_err2str(), alarm2str(), ast_best_codec(), ast_cause2str(), ast_channels_init(), ast_cli_netstats(), ast_codec2str(), ast_codec_choose(), ast_codec_pref_append(), ast_codec_pref_getsize(), ast_codec_pref_prepend(), ast_codec_pref_remove(), ast_codec_pref_setsize(), ast_describe_caller_presentation(), ast_dsp_prog_reset(), ast_dsp_set_call_progress_zone(), ast_event_cmp(), ast_event_str_to_event_type(), ast_event_str_to_ie_type(), ast_expand_codec_alias(), ast_extension_state2str(), ast_get_format_list(), ast_getformatbyname(), ast_getformatname(), ast_getformatname_multiple(), ast_image_init(), ast_named_caller_presentation(), ast_parse_caller_presentation(), ast_rtp_lookup_mime_subtype(), ast_rtp_set_rtpmap_type(), ast_str2cause(), ast_str2tos(), ast_timing_init(), ast_tos2str(), ast_tps_init(), ast_utils_init(), astobj2_init(), authority_to_str(), bearer2str(), cache_get_callno_locked(), cb_events(), check_blacklist(), common_exec(), complete_dpreply(), complete_ulimit(), conf_exec(), convert_attribute_name_from_ldap(), convert_attribute_name_to_ldap(), devstate_cache_cb(), dump_cause(), dump_ies(), dundi_eid_zero(), dundi_ie2str(), dundi_query_read(), event2str(), fac2str(), fill_rxgain(), fill_txgain(), find_alias(), find_cache(), find_sip_method(), find_subscription_type(), ftype2mtype(), get_perm(), geteventbyname(), getjustifybyname(), handle_cli_iax2_show_cache(), handle_cli_iax2_show_channels(), handle_cli_ulimit(), handle_input(), handle_jack_audio(), iax_ie2str(), iax_provflags2str(), iax_showframe(), iax_str2flags(), int2strat(), jack_status_to_str(), jb_choose_impl(), lin16tog722_sample(), lintog722_sample(), load_config(), load_module(), main(), milliwatt_generate(), minivm_accmess_exec(), minivm_greet_exec(), minivm_notify_exec(), minivm_record_exec(), mute_fragment(), parkandannounce_exec(), parse_naptr(), parse_sip_options(), pbx_retrieve_variable(), process_echocancel(), process_opcode(), process_returncode(), queue_voice_frame(), resample_frame(), rotate_file(), set_queue_result(), sip_show_channel(), slin16_to_slin8_sample(), slin8_to_slin16_sample(), ss_thread(), str2desc(), str2limit(), strat2int(), strings_to_mask(), subscription_type2str(), unload_module(), and update_max_trunk().

#define ast_assert

(

a

)

Definition at line 678 of file utils.h.

Referenced by ast_hangup(), ast_odbc_request_obj(), ast_rtcp_read(), ast_rtp_read(), ast_sched_del(), ast_udptl_read(), create_jb(), find_timer(), jb_get_and_deliver(), pthread_timer_ack(), and read_pipe().

#define AST_BACKGROUND_STACKSIZE   AST_STACKSIZE

Definition at line 362 of file utils.h.

#define ast_clear_flag	(	p,
		flag		)

Definition at line 75 of file utils.h.

Referenced by __ast_pbx_run(), __ast_read(), __do_deliver(), aji_filter_roster(), ast_app_parse_options(), ast_autoservice_stop(), ast_bridge_call(), ast_cdr_reset(), ast_cdr_specialized_reset(), ast_channel_bridge(), ast_channel_undefer_dtmf(), ast_deactivate_generator(), ast_hangup(), ast_jb_destroy(), ast_jb_put(), ast_park_call_full(), ast_rtp_stop(), ast_sendtext(), ast_speech_start(), ast_waitfor_nandfds(), ast_waitfordigit_full(), ast_write(), authenticate_verify(), bridge_p2p_loop(), build_peer(), build_user(), builtin_atxfer(), change_spy_mode(), channel_spy(), chanspy_exec(), check_goto_on_transfer(), check_pendings(), common_exec(), config_function_read(), config_text_file_load(), create_addr(), dahdi_read(), dial_exec_full(), dictate_exec(), disa_exec(), dundi_lookup_local(), extenspy_exec(), find_conf(), find_conf_realtime(), forward_message(), handle_command_response(), handle_common_options(), handle_exec(), handle_request_bye(), handle_request_invite(), handle_request_refer(), handle_response(), handle_response_notify(), handle_speechrecognize(), handle_t38_options(), handle_verbose(), iax2_destroy_helper(), init_acf_query(), linear_alloc(), load_config(), load_moh_classes(), local_ast_moh_stop(), local_attended_transfer(), local_hangup(), local_queue_frame(), main(), manage_parkinglot(), odbc_load_module(), parkandannounce_exec(), phone_read(), playtones_alloc(), process_sdp(), register_verify(), reload_config(), reset_transaction(), set_config(), set_config_destroy(), set_config_flags(), setup_dahdi(), sip_dtmfmode(), sip_hangup(), socket_process(), speech_background(), try_calling(), update_call_counter(), and waitstream_core().

#define ast_clear_flag64	(	p,
		flag		)

Definition at line 132 of file utils.h.

Referenced by do_forward(), and wait_for_answer().

#define ast_clear_flag_nonstd	(	p,
		flag		)

Value:

do { \
               ((p)->flags &= ~(flag)); \
               } while(0)

Definition at line 178 of file utils.h.

Referenced by build_transactions(), cache_lookup_internal(), dundi_lookup_local(), dundi_prop_precache(), and handle_command_response().

#define ast_copy_flags	(	dest,
		src,
		flagz		)

Definition at line 82 of file utils.h.

Referenced by __find_callno(), add_features_datastores(), agent_read(), aji_create_client(), aji_filter_roster(), ast_call_forward(), ast_cdr_reset(), ast_cdr_specialized_reset(), ast_feature_interpret(), ast_frdup(), ast_frisolate(), build_peer(), build_user(), builtin_atxfer(), cache_lookup_internal(), channel_spy(), check_access(), check_peer_ok(), create_addr(), create_addr_from_peer(), dundi_lookup_local(), framein(), iax2_request(), minivm_greet_exec(), minivm_record_exec(), park_exec_full(), populate_defaults(), realtime_peer(), register_verify(), set_peer_defaults(), sip_alloc(), sip_poke_peer(), transmit_response_using_temp(), and vm_exec().

#define ast_copy_flags64	(	dest,
		src,
		flagz		)

Definition at line 139 of file utils.h.

Referenced by dial_exec_full(), and wait_for_answer().

#define ast_copy_flags_nonstd	(	dest,
		src,
		flagz		)

Value:

do { \
               (dest)->flags &= ~(flagz); \
               (dest)->flags |= ((src)->flags & (flagz)); \
               } while (0)

Definition at line 182 of file utils.h.

#define AST_FLAGS_ALL   UINT_MAX

Definition at line 194 of file utils.h.

Referenced by add_features_datastores(), aji_create_client(), ast_app_parse_options(), ast_cdr_reset(), ast_cdr_specialized_reset(), ast_feature_interpret(), builtin_atxfer(), cache_lookup_internal(), channel_spy(), chanspy_exec(), check_goto_on_transfer(), dundi_lookup_local(), extenspy_exec(), load_moh_classes(), park_exec_full(), populate_defaults(), reload_config(), and set_config_flags().

#define ast_pthread_create	(	a,
		b,
		c,
		d		)

Value:

ast_pthread_create_stack(a, b, c, d,         \
      0, __FILE__, __FUNCTION__, __LINE__, #c)

Definition at line 376 of file utils.h.

Referenced by ast_bridge_call_thread_launch(), ast_dial_run(), ast_features_init(), ast_taskprocessor_get(), function_autopatchup(), handle_callforward_button(), handle_enbloc_call_message(), handle_offhook_message(), handle_soft_key_event_message(), handle_stimulus_message(), handle_transfer_button(), HandleCallOutgoing(), init_logger(), load_module(), local_dtmf_helper(), restart_monitor(), rpt_master(), rpt_telemetry(), setup_dahdi(), show_console(), sla_load_config(), and start_poll_thread().

#define ast_pthread_create_background	(	a,
		b,
		c,
		d		)

Value:

ast_pthread_create_stack(a, b, c, d,         \
      AST_BACKGROUND_STACKSIZE,        \
      __FILE__, __FUNCTION__, __LINE__, #c)

Definition at line 384 of file utils.h.

Referenced by aji_reload(), ast_autoservice_start(), ast_device_state_engine_init(), ast_enable_distributed_devstate(), ast_makesocket(), ast_tcptls_server_start(), conf_run(), do_monitor(), do_reload(), init_app_class(), init_timing_thread(), load_module(), local_ast_moh_start(), pri_dchannel(), reload_config(), restart_monitor(), sip_prepare_socket(), smdi_load(), start_network_thread(), start_pri(), start_stream(), store_config(), and usbradio_call().

#define ast_pthread_create_detached	(	a,
		b,
		c,
		d		)

Value:

ast_pthread_create_detached_stack(a, b, c, d,      \
      0, __FILE__, __FUNCTION__, __LINE__, #c)

Definition at line 380 of file utils.h.

Referenced by accept_thread(), action_originate(), ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_pbx_start(), dahdi_handle_event(), dundi_answer_entity(), dundi_answer_query(), dundi_prop_precache(), handle_hd_hf(), handle_init_event(), launch_service(), main(), mwi_thread(), pri_dchannel(), spawn_dp_lookup(), and start_network_thread().

#define ast_pthread_create_detached_background	(	a,
		b,
		c,
		d		)

Value:

ast_pthread_create_detached_stack(a, b, c, d,      \
      AST_BACKGROUND_STACKSIZE,        \
      __FILE__, __FUNCTION__, __LINE__, #c)

Definition at line 389 of file utils.h.

Referenced by ast_cdr_submit_batch(), ast_tcptls_server_root(), conf_run(), find_idle_thread(), iax_park(), launch_monitor_thread(), listener(), load_module(), sip_park(), sla_handle_dial_state_event(), and sla_station_exec().

#define ast_set2_flag	(	p,
		value,
		flag		)

Definition at line 92 of file utils.h.

Referenced by __ast_pbx_run(), _macro_exec(), aji_create_client(), aji_load_config(), apply_general_options(), apply_option(), apply_outgoing(), ast_bridge_call(), ast_jb_read_conf(), ast_readconfig(), ast_rtp_setdtmf(), ast_rtp_setdtmfcompensate(), ast_rtp_setstun(), ast_translate(), build_peer(), build_user(), check_access(), dial_exec_full(), do_reload(), find_account(), find_user(), forkcdr_exec(), handle_common_options(), handle_t38_options(), load_config(), load_module(), load_moh_classes(), local_ast_moh_start(), reload_config(), and set_config().

#define ast_set2_flag64	(	p,
		value,
		flag		)

Definition at line 149 of file utils.h.

Referenced by dial_exec_full().

#define ast_set2_flag_nonstd	(	p,
		value,
		flag		)

Definition at line 187 of file utils.h.

#define ast_set_flag	(	p,
		flag		)

Definition at line 68 of file utils.h.

Referenced by __ast_channel_alloc_ap(), __ast_pbx_run(), __ast_read(), __ast_request_and_dial(), _macro_exec(), action_redirect(), aji_load_config(), app_exec(), apply_peer(), ast_app_parse_options(), ast_autoservice_start(), ast_bridge_call(), ast_call(), ast_cdr_detach(), ast_cdr_fork(), ast_cdr_merge(), ast_cdr_reset(), ast_cdr_specialized_reset(), ast_channel_bridge(), ast_channel_defer_dtmf(), ast_do_masquerade(), ast_generic_bridge(), ast_hangup(), ast_jb_do_usecheck(), ast_jb_put(), ast_park_call_full(), ast_rtp_bridge(), ast_rtp_new_init(), ast_rtp_new_with_bindaddr(), ast_rtp_raw_write(), ast_rtp_read(), ast_speech_change_state(), ast_waitfor_nandfds(), ast_waitfordigit_full(), asyncgoto_exec(), authenticate_reply(), authenticate_request(), bridge_p2p_rtp_write(), build_peer(), build_user(), builtin_atxfer(), builtin_blindtransfer(), cb_extensionstate(), change_spy_mode(), channel_spy(), chanspy_exec(), check_access(), check_availability(), check_bridge(), check_peer_ok(), check_user_full(), check_via(), common_exec(), conf_exec(), connect_link(), create_addr_from_peer(), create_transaction(), dahdi_read(), decrypt_frame(), destroy_trans(), dial_exec_full(), dial_trunk(), dictate_exec(), directory_exec(), disa_exec(), do_register(), do_timelimit(), dundi_encrypt(), dundi_lookup_local(), dundi_send(), extenspy_exec(), find_peer(), find_user_realtime(), free_vm_users(), handle_cli_iax2_prune_realtime(), handle_command_response(), handle_common_options(), handle_exec(), handle_invite_replaces(), handle_request_invite(), handle_request_refer(), handle_request_subscribe(), handle_response(), handle_response_invite(), handle_t38_options(), handle_verbose(), hanguptree(), iax2_predestroy(), iax2_provision(), iax2_start_transfer(), init_acf_query(), init_app_class(), init_files_class(), init_outgoing(), interpret_t38_parameters(), launch_monitor_thread(), leave_voicemail(), linear_alloc(), load_config(), load_moh_classes(), local_alloc(), local_ast_moh_start(), local_attended_transfer(), local_call(), local_hangup(), local_queue_frame(), login_exec(), main(), manage_parkinglot(), manager_sipnotify(), minivm_greet_exec(), nocdr_exec(), odbc_load_module(), park_exec_full(), peer_delme_cb(), playtones_alloc(), post_cdr(), process_rfc3389(), process_sdp(), pvt_destructor(), qualify_peer(), realtime_peer(), realtime_user(), record_exec(), register_verify(), reload_config(), rpt(), rpt_call(), rpt_exec(), rpt_tele_thread(), run_station(), set_bridge_features_on_config(), set_config(), set_config_flags(), set_insecure_flags(), sip_answer(), sip_call(), sip_cli_notify(), sip_dtmfmode(), sip_hangup(), sip_indicate(), sip_poke_peer(), sip_reinvite_retry(), sip_send_mwi_to_peer(), sip_sendhtml(), sip_set_rtp_peer(), sip_set_udptl_peer(), sip_write(), sla_station_exec(), sla_trunk_exec(), socket_process(), start_spying(), tonepair_alloc(), transmit_register(), transmit_reinvite_with_sdp(), try_calling(), update_call_counter(), user_delme_cb(), vm_execmain(), volume_write(), and waitstream_core().

#define ast_set_flag64	(	p,
		flag		)

Definition at line 125 of file utils.h.

Referenced by ast_app_parse_options64(), and dial_exec_full().

#define ast_set_flag_nonstd	(	p,
		flag		)

Value:

do { \
               ((p)->flags |= (flag)); \
               } while(0)

Definition at line 174 of file utils.h.

Referenced by dundi_lookup_internal(), dundi_query_eid_internal(), and handle_command_response().

#define ast_set_flags_to	(	p,
		flag,
		value		)

Definition at line 102 of file utils.h.

Referenced by build_peer(), build_user(), and set_config().

#define ast_set_flags_to64	(	p,
		flag,
		value		)

Definition at line 159 of file utils.h.

#define AST_STACKSIZE   (((sizeof(void *) * 8 * 8) - 16) * 1024)

Definition at line 357 of file utils.h.

Referenced by ast_pthread_create_stack().

#define ast_strdupa

(

s

)

duplicate a string in memory from the stack

Parameters:

s

The string to duplicate

This macro will duplicate the given string. It returns a pointer to the stack allocatted memory for the new string.

Definition at line 616 of file utils.h.

Referenced by __ast_play_and_record(), __verboser(), _ast_device_state(), _build_port_config(), _macro_exec(), _parse(), _while_exec(), acf_channel_read(), acf_meetme_info(), acf_odbc_write(), action_agents(), action_status(), add_agent(), add_peer_mailboxes(), add_redirect(), add_var(), admin_exec(), advanced_options(), agent_logoff_maintenance(), agi_handle_command(), aji_send_exec(), aji_status_exec(), answer_exec_enable(), app_exec(), append_mailbox(), append_mailbox_mapping(), append_var_and_value_to_filter(), apply_options(), aqm_exec(), array(), ast_aji_get_client(), ast_app_getdata(), ast_append_ha(), ast_bridge_call(), ast_callerid_split(), ast_cdr_fork(), ast_eivr_setvariable(), ast_event_check_subscriber(), ast_event_new(), ast_feature_interpret(), ast_filehelper(), ast_format_str_reduce(), ast_func_read(), ast_func_write(), ast_get_group(), ast_mkdir(), ast_monitor_change_fname(), ast_monitor_start(), ast_netsock_bind(), ast_parse_allow_disallow(), ast_parse_arg(), ast_playtones_start(), ast_register_file_version(), ast_writefile(), astman_get_variables(), asyncgoto_exec(), auth_exec(), authenticate_reply(), authenticate_verify(), background_detect_exec(), bridge_exec(), bridge_play_sounds(), build_channels(), build_device(), build_gateway(), build_mapping(), build_peer(), build_profile(), build_user(), builtin_atxfer(), builtin_automixmonitor(), builtin_automonitor(), cache_get_callno_locked(), callerid_write(), chanavail_exec(), channel_admin_exec(), channel_spy(), chanspy_exec(), check_access(), check_blacklist(), check_goto_on_transfer(), check_peer_ok(), check_user_full(), complete_meetmecmd(), conf_exec(), conf_run(), conf_start_moh(), config_function_read(), config_module(), controlplayback_exec(), count_exec(), create_addr(), create_addr_from_peer(), create_vmaccount(), cut_internal(), dahdi_request(), dahdiras_exec(), decrypt_frame(), del_exec(), deltree_exec(), dial_exec_full(), dial_trunk(), dialgroup_refreshdb(), dialgroup_write(), dictate_exec(), directory_exec(), disa_exec(), do_immediate_setup(), do_message(), do_say(), do_timelimit(), dundi_query_read(), dundi_result_read(), dundifunc_read(), enum_query_read(), enum_result_read(), exec_exec(), execif_exec(), extenspy_exec(), festival_exec(), fileexists_core(), find_conf_realtime(), find_gtalk(), find_sdp(), find_table(), find_table_cb(), findmeexec(), forkcdr_exec(), function_agent(), function_iaxpeer(), function_realtime_store(), get_destination(), get_refer_info(), gosub_exec(), gosubif_exec(), gtalk_action(), gtalk_alloc(), gtalk_create_candidates(), gtalk_digit(), gtalk_invite(), gtalk_invite_response(), gtalk_request(), handle_call_forward(), handle_cli_file_convert(), handle_debug_dialplan(), handle_options(), handle_request_invite(), handle_request_subscribe(), handle_response(), handle_show_dialplan(), handle_t38_options(), has_voicemail(), iax2_call(), iax2_devicestate(), iax2_prov_app(), iax2_request(), iconv_read(), ind_load_module(), init_acf_query(), init_jack_data(), insert_penaltychange(), is_prefix(), is_valid_dtmf(), isAnsweringMachine(), isexten_function_read(), ivr_dispatch(), jingle_request(), launch_monitor_thread(), launch_netscript(), leave_voicemail(), load_config(), local_devicestate(), log_exec(), login_exec(), lua_func_read(), lua_get_variable(), lua_get_variable_value(), lua_pbx_exec(), lua_set_variable_value(), macroif_exec(), main(), make_components(), make_email_file(), manage_parkinglot(), masq_park_call(), meetmemute(), metermaidstate(), mgcp_devicestate(), minivm_accmess_exec(), minivm_account_func_read(), minivm_counter_func_read(), minivm_counter_func_write(), minivm_greet_exec(), minivm_notify_exec(), minivm_record_exec(), misdn_call(), misdn_check_l2l1(), misdn_facility_exec(), misdn_request(), misdn_set_opt_exec(), mixmonitor_exec(), mkintf(), moh_handle_digit(), monitor_dial(), notify_message(), notify_new_message(), orig_app(), orig_exten(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), page_exec(), park_call_exec(), park_space_reserve(), parkandannounce_exec(), parse_session_expires(), parse_sip_options(), parse_uri(), pbx_builtin_background(), pbx_builtin_execiftime(), pbx_builtin_gotoif(), pbx_builtin_gotoiftime(), pbx_builtin_importvar(), pbx_builtin_pushvar_helper(), pbx_builtin_resetcdr(), pbx_builtin_setvar(), pbx_builtin_setvar_helper(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), pbx_find_extension(), pbx_parseable_goto(), pbx_retrieve_variable(), peer_set_srcaddr(), pickup_exec(), pickupchan_exec(), play_message(), play_moh_exec(), playback_exec(), pqm_exec(), prep_email_sub_vars(), privacy_exec(), process_dahdi(), process_echocancel(), process_sdp(), process_sdp_o(), ql_exec(), queue_exec(), queue_mwi_event(), queue_set_param(), rcvfax_exec(), read_exec(), readexten_exec(), readfile_exec(), realtime_common(), realtime_exec(), realtime_multi_curl(), realtime_multi_odbc(), realtime_multi_pgsql(), record_exec(), register_verify(), registry_authrequest(), reload_config(), reload_followme(), replace_cid(), resource_name_match(), retrydial_exec(), rqm_exec(), sayunixtime_exec(), senddtmf_exec(), sendmail(), sendtext_exec(), sendurl_exec(), set_config_flags(), setup_privacy_args(), sip_devicestate(), sip_new(), sip_sipredirect(), sip_uri_cmp(), sip_uri_headers_cmp(), sip_uri_params_cmp(), skinny_devicestate(), sla_add_trunk_to_station(), sla_check_device(), sla_queue_event_conf(), sla_ring_station(), sla_state(), sla_station_exec(), sla_trunk_exec(), smdi_msg_read(), smdi_msg_retrieve_read(), sms_exec(), sndfax_exec(), socket_process(), softhangup_exec(), sort_internal(), speech_background(), speech_load(), start_moh_exec(), start_monitor_action(), start_monitor_exec(), timezone_add(), transfer_exec(), transmit_invite(), transmit_refer(), try_calling(), tryexec_exec(), unistim_send_mwi_to_peer(), update_bridge_vars(), update_common_options(), update_registry(), upqm_exec(), userevent_exec(), verbose_exec(), vm_box_exists(), vm_check_password_shell(), vm_exec(), vm_execmain(), vmauthenticate(), wait_for_winner(), waitstream_core(), and zapateller_exec().

#define ast_test_flag	(	p,
		flag		)

Definition at line 61 of file utils.h.

Referenced by __ast_pbx_run(), __ast_queue_frame(), __ast_read(), __do_deliver(), __expire_registry(), __get_from_jb(), __iax2_show_peers(), __sip_destroy(), _macro_exec(), _sip_show_peer(), _sip_show_peers(), acf_odbc_read(), add_agent(), add_codec_to_sdp(), add_sdp(), aji_pruneregister(), app_exec(), ast_audiohook_write_frame(), ast_autoservice_start(), ast_bridge_call(), ast_call(), ast_cdr_answer(), ast_cdr_appenduserfield(), ast_cdr_busy(), ast_cdr_end(), ast_cdr_failed(), ast_cdr_fork(), ast_cdr_init(), ast_cdr_merge(), ast_cdr_noanswer(), ast_cdr_reset(), ast_cdr_setaccount(), ast_cdr_setamaflags(), ast_cdr_setanswer(), ast_cdr_setapp(), ast_cdr_setcid(), ast_cdr_setdestchan(), ast_cdr_setdisposition(), ast_cdr_setuserfield(), ast_cdr_setvar(), ast_cdr_specialized_reset(), ast_cdr_start(), ast_cdr_update(), ast_channel_bridge(), ast_channel_defer_dtmf(), ast_channel_free(), ast_cli_netstats(), ast_do_masquerade(), ast_explicit_goto(), ast_frisolate(), ast_hangup(), ast_indicate_data(), ast_jb_destroy(), ast_jb_do_usecheck(), ast_jb_empty_and_reset(), ast_jb_get_and_deliver(), ast_jb_get_when_to_wakeup(), ast_jb_put(), ast_moh_files_next(), ast_park_call_full(), ast_quiet_chan(), ast_raw_answer(), ast_readstring_full(), ast_rtp_bridge(), ast_rtp_early_bridge(), ast_rtp_getnat(), ast_rtp_make_compatible(), ast_rtp_raw_write(), ast_sendtext(), ast_softhangup_nolock(), ast_streamfile(), ast_transfer(), ast_translate(), ast_waitfordigit_full(), ast_write(), auth_exec(), authenticate_request(), authenticate_verify(), bridge_exec(), bridge_native_loop(), bridge_p2p_rtp_write(), build_peer(), build_radius_record(), build_user(), build_via(), callback_dialoptions(), cb_extensionstate(), cdr_read(), cdr_write(), channel_spy(), chanspy_exec(), check_access(), check_bridge(), check_peer_ok(), check_pendings(), check_post(), check_rtp_timeout(), check_user_full(), close_mailbox(), common_exec(), complete_sip_peer(), complete_sip_registered_peer(), conf_exec(), config_text_file_load(), controlplayback_exec(), copy_via_headers(), create_addr(), create_addr_from_peer(), create_jb(), decrypt_frame(), destroy_trans(), dial_exec_full(), dictate_exec(), directory_exec(), disa_exec(), do_directory(), dtmf_audiohook_write_list(), dundi_encrypt(), dundi_exec(), dundi_helper(), dundi_lookup_local(), dundi_lookup_thread(), dundi_precache_thread(), dundi_query_read(), dundi_query_thread(), dundi_rexmit(), dundi_send(), dundifunc_read(), eivr_comm(), execute_cb(), expire_register(), extenspy_exec(), feature_exec_app(), feature_interpret_helper(), find_cache(), find_call_cb(), find_conf(), find_conf_realtime(), find_or_create(), find_user(), find_user_realtime(), forkcdr_exec(), forward_message(), free_user(), function_iaxpeer(), get_destination(), get_insecure_variable_from_config(), gosub_exec(), handle_cli_iax2_prune_realtime(), handle_cli_iax2_show_channels(), handle_cli_iax2_show_peer(), handle_cli_iax2_show_users(), handle_cli_moh_show_classes(), handle_command_response(), handle_exec(), handle_frame(), handle_minivm_show_settings(), handle_options(), handle_request_bye(), handle_request_cancel(), handle_request_info(), handle_request_invite(), handle_request_refer(), handle_request_subscribe(), handle_response(), handle_response_invite(), handle_response_notify(), handle_show_settings(), handle_showchan(), handle_skinny_show_settings(), handle_speechrecognize(), handle_tcptls_connection(), hint_read(), iax2_bridge(), iax2_call(), iax2_destroy_helper(), iax2_getpeertrunk(), iax2_hangup(), iax2_predestroy(), iax2_request(), iax2_send(), iax2_trunk_queue(), iax2_write(), initreqprep(), interpret_t38_parameters(), leave_voicemail(), load_resource(), local_alloc(), local_ast_moh_start(), local_bridgedchannel(), local_hangup(), local_indicate(), local_queue_frame(), local_write(), log_jitterstats(), main(), make_email_file(), manager_iax2_show_peer_list(), manager_list_voicemail_users(), minivm_accmess_exec(), minivm_account_func_read(), minivm_greet_exec(), minivm_notify_exec(), minivm_record_exec(), mixmonitor_exec(), mixmonitor_thread(), mod_load_cmp(), moh_files_alloc(), moh_scan_files(), notify_new_message(), p2p_callback_disable(), page_exec(), park_space_reserve(), parse_moved_contact(), parse_register_contact(), pbx_builtin_background(), pbx_builtin_waitexten(), peer_ipcmp_cb(), pick_unlocked_cdr(), play_mailbox_owner(), play_message(), play_record_review(), post_cdr(), precache_transactions(), process_cisco_dtmf(), process_rfc2833(), process_rfc3389(), process_sdp(), process_sdp_a_audio(), process_sdp_o(), process_text_line(), prune_peers(), prune_users(), read_exec(), readexten_exec(), realtime_peer(), realtime_user(), record_exec(), reg_source_db(), register_verify(), reload_config(), remove_from_queue(), replace_cid(), reqprep(), respprep(), retrydial_exec(), rpt_master(), schedule_delivery(), search_directory(), select_entry(), send_dtmf(), send_request(), send_trunk(), sendmail(), sendurl_exec(), serialize_showchan(), set_address_from_contact(), set_config(), set_config_flags(), set_t38_capabilities(), should_skip_dtmf(), show_channels_cb(), sip_alloc(), sip_dtmfmode(), sip_fixup(), sip_get_rtp_peer(), sip_get_trtp_peer(), sip_get_udptl_peer(), sip_get_vrtp_peer(), sip_hangup(), sip_indicate(), sip_nat_mode(), sip_new(), sip_prune_realtime(), sip_queryoption(), sip_read(), sip_real_dst(), sip_rtp_read(), sip_send_mwi_to_peer(), sip_senddigit_begin(), sip_senddigit_end(), sip_sendhtml(), sip_set_rtp_peer(), sip_set_udptl_peer(), sip_show_channel(), sip_show_settings(), sip_show_user(), sip_show_users(), sip_write(), sla_trunk_exec(), smdi_msg_find(), sms_exec(), socket_process(), socket_process_meta(), softhangup_exec(), spawn_mp3(), speech_background(), speech_read(), spy_generate(), start_spying(), startmon(), transmit_info_with_digit(), transmit_notify_with_mwi(), transmit_refer(), transmit_reinvite_with_sdp(), transmit_response_using_temp(), transmit_response_with_sdp(), try_calling(), update_call_counter(), update_peer(), update_registry(), vm_exec(), vm_execmain(), vm_instructions_en(), vm_intro(), vm_newuser(), and waitstream_core().

#define ast_test_flag64	(	p,
		flag		)

Definition at line 118 of file utils.h.

Referenced by ast_app_options2str64(), dial_exec_full(), do_forward(), retrydial_exec(), setup_privacy_args(), valid_priv_reply(), and wait_for_answer().

#define ast_test_flag_nonstd	(	p,
		flag		)	((p)->flags & (flag))

Definition at line 171 of file utils.h.

Referenced by cache_save_hint(), dundi_lookup_thread(), dundi_precache_thread(), and handle_command_response().

#define localtime_r   __dont_use_localtime_r_use_ast_localtime_instead__

Definition at line 318 of file utils.h.

#define MAX	(	a,
		b		)	({ typeof(a) __a = (a); typeof(b) __b = (b); ((__a < __b) ? __b : __a);})

Definition at line 226 of file utils.h.

Referenced by __ast_answer(), and handle_response_register().

#define MIN	(	a,
		b		)	({ typeof(a) __a = (a); typeof(b) __b = (b); ((__a > __b) ? __b : __a);})

Definition at line 224 of file utils.h.

Referenced by _sip_tcp_helper_thread(), autoanswer_complete(), calculate_local_max_datagram(), h263p_encap(), h264_encap(), interpret_t38_parameters(), and mpeg4_encap().

---

Function Documentation

int ast_base64decode	(	unsigned char *	dst,
		const char *	src,
		int	max
	)

Decode data from base64.

Parameters:

	dst	the destination buffer
	src	the source buffer
	max	The maximum number of bytes to write into the destination buffer. Note that this function will not ensure that the destination buffer is NULL terminated. So, in general, this parameter should be sizeof(dst) - 1.

Definition at line 264 of file utils.c.

Referenced by __ast_check_signature(), base64_decode(), and osp_validate_token().

{
   int cnt = 0;
   unsigned int byte = 0;
   unsigned int bits = 0;
   int incnt = 0;
   while(*src && *src != '=' && (cnt < max)) {
      /* Shift in 6 bits of input */
      byte <<= 6;
      byte |= (b2a[(int)(*src)]) & 0x3f;
      bits += 6;
      src++;
      incnt++;
      /* If we have at least 8 bits left over, take that character 
         off the top */
      if (bits >= 8)  {
         bits -= 8;
         *dst = (byte >> bits) & 0xff;
         dst++;
         cnt++;
      }
   }
   /* Dont worry about left over bits, they're extra anyway */
   return cnt;
}

int ast_base64encode	(	char *	dst,
		const unsigned char *	src,
		int	srclen,
		int	max
	)

Encode data in base64.

Parameters:

	dst	the destination buffer
	src	the source data to be encoded
	srclen	the number of bytes present in the source buffer
	max	the maximum number of bytes to write into the destination buffer, *including* the terminating NULL character.

Definition at line 342 of file utils.c.

References ast_base64encode_full().

Referenced by __ast_sign(), aji_start_sasl(), base64_encode(), build_secret(), and osp_check_destination().

{
   return ast_base64encode_full(dst, src, srclen, max, 0);
}

int ast_base64encode_full	(	char *	dst,
		const unsigned char *	src,
		int	srclen,
		int	max,
		int	linebreaks
	)

encode text to BASE64 coding

Definition at line 291 of file utils.c.

Referenced by ast_base64encode().

{
   int cnt = 0;
   int col = 0;
   unsigned int byte = 0;
   int bits = 0;
   int cntin = 0;
   /* Reserve space for null byte at end of string */
   max--;
   while ((cntin < srclen) && (cnt < max)) {
      byte <<= 8;
      byte |= *(src++);
      bits += 8;
      cntin++;
      if ((bits == 24) && (cnt + 4 <= max)) {
         *dst++ = base64[(byte >> 18) & 0x3f];
         *dst++ = base64[(byte >> 12) & 0x3f];
         *dst++ = base64[(byte >> 6) & 0x3f];
         *dst++ = base64[byte & 0x3f];
         cnt += 4;
         col += 4;
         bits = 0;
         byte = 0;
      }
      if (linebreaks && (cnt < max) && (col == 64)) {
         *dst++ = '\n';
         cnt++;
         col = 0;
      }
   }
   if (bits && (cnt + 4 <= max)) {
      /* Add one last character for the remaining bits, 
         padding the rest with 0 */
      byte <<= 24 - bits;
      *dst++ = base64[(byte >> 18) & 0x3f];
      *dst++ = base64[(byte >> 12) & 0x3f];
      if (bits == 16)
         *dst++ = base64[(byte >> 6) & 0x3f];
      else
         *dst++ = '=';
      *dst++ = '=';
      cnt += 4;
   }
   if (linebreaks && (cnt < max)) {
      *dst++ = '\n';
      cnt++;
   }
   *dst = '\0';
   return cnt;
}

int ast_careful_fwrite	(	FILE *	f,
		int	fd,
		const char *	s,
		size_t	len,
		int	timeoutms
	)

Write data to a file stream with a timeout.

Parameters:

	f	the file stream to write to
	fd	the file description to poll on to know when the file stream can be written to without blocking.
	s	the buffer to write from
	len	the number of bytes to write
	timeoutms	The maximum amount of time to block in this function trying to write, specified in milliseconds.

Note:

This function assumes that the associated file stream has been set up as non-blocking.

Return values:

	0	success
	-1	error

Definition at line 1154 of file utils.c.

References ast_log(), ast_tvdiff_ms(), ast_tvnow(), ast_wait_for_output(), errno, and LOG_ERROR.

Referenced by send_string().

{
   struct timeval start = ast_tvnow();
   int n = 0;
   int elapsed = 0;

   while (len) {
      if (ast_wait_for_output(fd, timeoutms - elapsed)) {
         /* poll returned a fatal error, so bail out immediately. */
         return -1;
      }

      /* Clear any errors from a previous write */
      clearerr(f);

      n = fwrite(src, 1, len, f);

      if (ferror(f) && errno != EINTR && errno != EAGAIN) {
         /* fatal error from fwrite() */
         if (!feof(f)) {
            /* Don't spam the logs if it was just that the connection is closed. */
            ast_log(LOG_ERROR, "fwrite() returned error: %s\n", strerror(errno));
         }
         n = -1;
         break;
      }

      /* Update for data already written to the socket */
      len -= n;
      src += n;

      elapsed = ast_tvdiff_ms(ast_tvnow(), start);
      if (elapsed >= timeoutms) {
         /* We've taken too long to write 
          * This is only an error condition if we haven't finished writing. */
         n = len ? -1 : 0;
         break;
      }
   }

   while (fflush(f)) {
      if (errno == EAGAIN || errno == EINTR) {
         continue;
      }
      if (!feof(f)) {
         /* Don't spam the logs if it was just that the connection is closed. */
         ast_log(LOG_ERROR, "fflush() returned error: %s\n", strerror(errno));
      }
      n = -1;
      break;
   }

   return n < 0 ? -1 : 0;
}

int ast_carefulwrite	(	int	fd,
		char *	s,
		int	len,
		int	timeoutms
	)

Try to write string, but wait no more than ms milliseconds before timing out.

Note:

If you are calling ast_carefulwrite, it is assumed that you are calling it on a file descriptor that _DOES_ have NONBLOCK set. This way, there is only one system call made to do a write, unless we actually have a need to wait. This way, we get better performance.

Try to write string, but wait no more than ms milliseconds before timing out.

Note:

The code assumes that the file descriptor has NONBLOCK set, so there is only one system call made to do a write, unless we actually have a need to wait. This way, we get better performance. If the descriptor is blocking, all assumptions on the guaranteed detail do not apply anymore.

Definition at line 1113 of file utils.c.

References ast_log(), ast_tvdiff_ms(), ast_tvnow(), ast_wait_for_output(), errno, and LOG_ERROR.

Referenced by ast_agi_send(), and ast_cli().

{
   struct timeval start = ast_tvnow();
   int res = 0;
   int elapsed = 0;

   while (len) {
      if (ast_wait_for_output(fd, timeoutms - elapsed)) {
         return -1;
      }

      res = write(fd, s, len);

      if (res < 0 && errno != EAGAIN && errno != EINTR) {
         /* fatal error from write() */
         ast_log(LOG_ERROR, "write() returned error: %s\n", strerror(errno));
         return -1;
      }

      if (res < 0) {
         /* It was an acceptable error */
         res = 0;
      }

      /* Update how much data we have left to write */
      len -= res;
      s += res;
      res = 0;

      elapsed = ast_tvdiff_ms(ast_tvnow(), start);
      if (elapsed >= timeoutms) {
         /* We've taken too long to write 
          * This is only an error condition if we haven't finished writing. */
         res = len ? -1 : 0;
         break;
      }
   }

   return res;
}

int ast_eid_cmp	(	const struct ast_eid *	eid1,
		const struct ast_eid *	eid2
	)

Compare two EIDs.

Returns:

0 if the two are the same, non-zero otherwise

Since:

1.6.1

Definition at line 294 of file netsock.c.

Referenced by build_peer(), build_transactions(), destroy_trans(), dundi_answer_entity(), dundi_answer_query(), dundi_ie_append_eid_appropriately(), dundi_lookup_internal(), dundi_prop_precache(), dundi_query_thread(), find_peer(), handle_command_response(), optimize_transactions(), and register_request().

{
   return memcmp(eid1, eid2, sizeof(*eid1));
}

char* ast_eid_to_str	(	char *	s,
		int	maxlen,
		struct ast_eid *	eid
	)

/brief Convert an EID to a string

Since:

1.6.1

Definition at line 218 of file netsock.c.

References ast_eid::eid.

Referenced by append_transaction(), ast_set_default_eid(), build_peer(), build_transactions(), cache_lookup(), cache_lookup_internal(), check_key(), complete_peer_helper(), destroy_trans(), do_autokill(), do_register(), do_register_expire(), dump_answer(), dump_eid(), dundi_answer_entity(), dundi_lookup_internal(), dundi_lookup_local(), dundi_lookup_thread(), dundi_precache_thread(), dundi_prop_precache(), dundi_query_thread(), dundi_send(), dundi_show_entityid(), dundi_show_peer(), dundi_show_peers(), dundi_show_requests(), handle_command_response(), handle_show_settings(), pbx_retrieve_variable(), populate_addr(), register_request(), and update_key().

{
   int x;
   char *os = s;
   if (maxlen < 18) {
      if (s && (maxlen > 0))
         *s = '\0';
   } else {
      for (x = 0; x < 5; x++) {
         sprintf(s, "%02x:", eid->eid[x]);
         s += 3;
      }
      sprintf(s, "%02x", eid->eid[5]);
   }
   return os;
}

void ast_enable_packet_fragmentation

(

int

sock

)

Disable PMTU discovery on a socket.

Parameters:

sock

The socket to manipulate

Returns:

Nothing

On Linux, UDP sockets default to sending packets with the Dont Fragment (DF) bit set. This is supposedly done to allow the application to do PMTU discovery, but Asterisk does not do this.

Because of this, UDP packets sent by Asterisk that are larger than the MTU of any hop in the path will be lost. This function can be called on a socket to ensure that the DF bit will not be set.

Definition at line 1815 of file utils.c.

References ast_log(), and LOG_WARNING.

Referenced by ast_netsock_bindaddr(), and reload_config().

{
#if defined(HAVE_IP_MTU_DISCOVER)
   int val = IP_PMTUDISC_DONT;
   
   if (setsockopt(sock, IPPROTO_IP, IP_MTU_DISCOVER, &val, sizeof(val)))
      ast_log(LOG_WARNING, "Unable to disable PMTU discovery. Large UDP packets may fail to be delivered when sent from this socket.\n");
#endif /* HAVE_IP_MTU_DISCOVER */
}

static void ast_free_ptr

(

void *

ptr

)

[static]

free() wrapper

ast_free_ptr should be used when a function pointer for free() needs to be passed as the argument to a function. Otherwise, astmm will cause seg faults.

Definition at line 415 of file utils.h.

References ast_free.

Referenced by ast_extension_state_add(), ast_merge_contexts_and_delete(), ast_park_call_full(), build_parkinglot(), handle_cli_dialplan_add_extension(), load_module(), manage_parkinglot(), pbx_load_config(), pbx_load_users(), register_exten(), register_peer_exten(), sla_build_station(), and sla_build_trunk().

{
   ast_free(ptr);
}

struct hostent* ast_gethostbyname	(	const char *	host,
		struct ast_hostent *	hp
	)			[read]

Thread-safe gethostbyname function to use in Asterisk.

Definition at line 182 of file utils.c.

References ast_hostent::buf, gethostbyname_r(), ast_hostent::hp, and s.

Referenced by __ast_http_load(), __init_manager(), __set_address_from_contact(), app_exec(), ast_find_ourip(), ast_get_ip_or_srv(), ast_parse_arg(), build_peer(), check_via(), create_addr(), festival_exec(), get_ip_and_port_from_sdp(), gtalk_load_config(), gtalk_update_stun(), handle_cli_udptl_debug_deprecated(), handle_cli_udptl_set_debug(), iax_template_parse(), jingle_load_config(), jingle_update_stun(), launch_netscript(), parse_register_contact(), process_sdp(), process_sdp_c(), realtime_peer(), realtime_user(), reload_config(), rpt_exec(), rtcp_do_debug_ip(), rtp_do_debug_ip(), set_config(), set_destination(), and sip_do_debug_ip().

{
   int res;
   int herrno;
   int dots = 0;
   const char *s;
   struct hostent *result = NULL;
   /* Although it is perfectly legitimate to lookup a pure integer, for
      the sake of the sanity of people who like to name their peers as
      integers, we break with tradition and refuse to look up a
      pure integer */
   s = host;
   res = 0;
   while (s && *s) {
      if (*s == '.')
         dots++;
      else if (!isdigit(*s))
         break;
      s++;
   }
   if (!s || !*s) {
      /* Forge a reply for IP's to avoid octal IP's being interpreted as octal */
      if (dots != 3)
         return NULL;
      memset(hp, 0, sizeof(struct ast_hostent));
      hp->hp.h_addrtype = AF_INET;
      hp->hp.h_addr_list = (void *) hp->buf;
      hp->hp.h_addr = hp->buf + sizeof(void *);
      if (inet_pton(AF_INET, host, hp->hp.h_addr) > 0)
         return &hp->hp;
      return NULL;
      
   }
#ifdef HAVE_GETHOSTBYNAME_R_5
   result = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &herrno);

   if (!result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
      return NULL;
#else
   res = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &result, &herrno);

   if (res || !result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
      return NULL;
#endif
   return &hp->hp;
}

void ast_md5_hash	(	char *	output,
		char *	input
	)

Produces MD5 hash based on input string.

Definition at line 230 of file utils.c.

References MD5Final(), MD5Init(), and MD5Update().

Referenced by auth_exec(), build_reply_digest(), check_auth(), and md5().

{
   struct MD5Context md5;
   unsigned char digest[16];
   char *ptr;
   int x;

   MD5Init(&md5);
   MD5Update(&md5, (unsigned char *)input, strlen(input));
   MD5Final(digest, &md5);
   ptr = output;
   for (x = 0; x < 16; x++)
      ptr += sprintf(ptr, "%2.2x", digest[x]);
}

int ast_mkdir	(	const char *	path,
		int	mode
	)

Recursively create directory path.

Parameters:

	path	The directory path to create
	mode	The permissions with which to try to create the directory

Returns:

0 on success or an error code otherwise

Creates a directory path, creating parent directories as needed.

Definition at line 1825 of file utils.c.

References ast_strdupa, errno, and len().

Referenced by ast_monitor_change_fname(), ast_monitor_start(), conf_run(), create_dirpath(), dictate_exec(), init_logger(), load_module(), mixmonitor_exec(), record_exec(), reload_logger(), remove_from_queue(), setup_privacy_args(), sms_nextoutgoing(), sms_writefile(), testclient_exec(), testserver_exec(), and write_history().

{
   char *ptr;
   int len = strlen(path), count = 0, x, piececount = 0;
   char *tmp = ast_strdupa(path);
   char **pieces;
   char *fullpath = alloca(len + 1);
   int res = 0;

   for (ptr = tmp; *ptr; ptr++) {
      if (*ptr == '/')
         count++;
   }

   /* Count the components to the directory path */
   pieces = alloca(count * sizeof(*pieces));
   for (ptr = tmp; *ptr; ptr++) {
      if (*ptr == '/') {
         *ptr = '\0';
         pieces[piececount++] = ptr + 1;
      }
   }

   *fullpath = '\0';
   for (x = 0; x < piececount; x++) {
      /* This looks funky, but the buffer is always ideally-sized, so it's fine. */
      strcat(fullpath, "/");
      strcat(fullpath, pieces[x]);
      res = mkdir(fullpath, mode);
      if (res && errno != EEXIST)
         return errno;
   }
   return 0;
}

char* ast_process_quotes_and_slashes	(	char *	start,
		char	find,
		char	replace_with
	)

Process a string to find and replace characters.

Parameters:

	start	The string to analyze
	find	The character to find
	replace_with	The character that will replace the one we are looking for

Definition at line 1425 of file utils.c.

{
   char *dataPut = start;
   int inEscape = 0;
   int inQuotes = 0;

   for (; *start; start++) {
      if (inEscape) {
         *dataPut++ = *start;       /* Always goes verbatim */
         inEscape = 0;
      } else {
         if (*start == '\\') {
            inEscape = 1;      /* Do not copy \ into the data */
         } else if (*start == '\'') {
            inQuotes = 1 - inQuotes;   /* Do not copy ' into the data */
         } else {
            /* Replace , with |, unless in quotes */
            *dataPut++ = inQuotes ? *start : ((*start == find) ? replace_with : *start);
         }
      }
   }
   if (start != dataPut)
      *dataPut = 0;
   return dataPut;
}

int ast_pthread_create_detached_stack	(	pthread_t *	thread,
		pthread_attr_t *	attr,
		void *(*)(void *)	start_routine,
		void *	data,
		size_t	stacksize,
		const char *	file,
		const char *	caller,
		int	line,
		const char *	start_fn
	)

Definition at line 1026 of file utils.c.

References ast_log(), ast_pthread_create_stack(), errno, LOG_WARNING, and thr_arg::start_routine.

{
   unsigned char attr_destroy = 0;
   int res;

   if (!attr) {
      attr = alloca(sizeof(*attr));
      pthread_attr_init(attr);
      attr_destroy = 1;
   }

   if ((errno = pthread_attr_setdetachstate(attr, PTHREAD_CREATE_DETACHED)))
      ast_log(LOG_WARNING, "pthread_attr_setdetachstate: %s\n", strerror(errno));

   res = ast_pthread_create_stack(thread, attr, start_routine, data, 
                                  stacksize, file, caller, line, start_fn);

   if (attr_destroy)
      pthread_attr_destroy(attr);

   return res;
}

int ast_pthread_create_stack	(	pthread_t *	thread,
		pthread_attr_t *	attr,
		void *(*)(void *)	start_routine,
		void *	data,
		size_t	stacksize,
		const char *	file,
		const char *	caller,
		int	line,
		const char *	start_fn
	)

Definition at line 977 of file utils.c.

References asprintf, ast_log(), ast_malloc, AST_STACKSIZE, thr_arg::data, dummy_start(), errno, LOG_WARNING, thr_arg::name, pthread_create, and thr_arg::start_routine.

Referenced by ast_pthread_create_detached_stack().

{
#if !defined(LOW_MEMORY)
   struct thr_arg *a;
#endif

   if (!attr) {
      attr = alloca(sizeof(*attr));
      pthread_attr_init(attr);
   }

#ifdef __linux__
   /* On Linux, pthread_attr_init() defaults to PTHREAD_EXPLICIT_SCHED,
      which is kind of useless. Change this here to
      PTHREAD_INHERIT_SCHED; that way the -p option to set realtime
      priority will propagate down to new threads by default.
      This does mean that callers cannot set a different priority using
      PTHREAD_EXPLICIT_SCHED in the attr argument; instead they must set
      the priority afterwards with pthread_setschedparam(). */
   if ((errno = pthread_attr_setinheritsched(attr, PTHREAD_INHERIT_SCHED)))
      ast_log(LOG_WARNING, "pthread_attr_setinheritsched: %s\n", strerror(errno));
#endif

   if (!stacksize)
      stacksize = AST_STACKSIZE;

   if ((errno = pthread_attr_setstacksize(attr, stacksize ? stacksize : AST_STACKSIZE)))
      ast_log(LOG_WARNING, "pthread_attr_setstacksize: %s\n", strerror(errno));

#if !defined(LOW_MEMORY)
   if ((a = ast_malloc(sizeof(*a)))) {
      a->start_routine = start_routine;
      a->data = data;
      start_routine = dummy_start;
      if (asprintf(&a->name, "%-20s started at [%5d] %s %s()",
              start_fn, line, file, caller) < 0) {
         ast_log(LOG_WARNING, "asprintf() failed: %s\n", strerror(errno));
         a->name = NULL;
      }
      data = a;
   }
#endif /* !LOW_MEMORY */

   return pthread_create(thread, attr, start_routine, data); /* We're in ast_pthread_create, so it's okay */
}

long int ast_random

(

void

)

Definition at line 1401 of file utils.c.

References ast_mutex_lock(), and ast_mutex_unlock().

Referenced by acf_rand_exec(), action_challenge(), add_sdp(), agent_new(), agi_handle_command(), ast_lock_path_lockfile(), ast_moh_files_next(), ast_rtp_new_init(), ast_rtp_new_source(), ast_rtp_new_with_bindaddr(), ast_udptl_new_with_bindaddr(), authenticate_request(), build_gateway(), build_iv(), build_rand_pad(), build_reply_digest(), calc_metric(), calc_rxstamp(), callno_hash(), dahdi_new(), generate_random_string(), generic_http_callback(), get_trans_id(), gtalk_alloc(), gtalk_create_candidates(), gtalk_new(), handle_response_invite(), iax2_key_rotate(), iax2_start_transfer(), jingle_alloc(), jingle_create_candidates(), jingle_new(), load_module(), local_new(), make_email_file(), make_our_tag(), moh_files_alloc(), ogg_vorbis_rewrite(), osp_create_uuid(), page_exec(), park_space_reserve(), process_weights(), reg_source_db(), registry_authrequest(), reqprep(), say_periodic_announcement(), sendmail(), set_nonce_randdata(), sip_alloc(), socket_read(), start_rtp(), stun_req_id(), transmit_invite(), transmit_register(), transmit_response_using_temp(), try_calling(), and try_firmware().

{
   long int res;
#ifdef HAVE_DEV_URANDOM
   if (dev_urandom_fd >= 0) {
      int read_res = read(dev_urandom_fd, &res, sizeof(res));
      if (read_res > 0) {
         long int rm = RAND_MAX;
         res = res < 0 ? ~res : res;
         rm++;
         return res % rm;
      }
   }
#endif
#ifdef linux
   res = random();
#else
   ast_mutex_lock(&randomlock);
   res = random();
   ast_mutex_unlock(&randomlock);
#endif
   return res;
}

void ast_register_thread

(

char *

name

)

Definition at line 348 of file asterisk.c.

References ast_calloc, AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by dummy_start().

{ 
   struct thread_list_t *new = ast_calloc(1, sizeof(*new));

   if (!new)
      return;
   new->id = pthread_self();
   new->name = name; /* steal the allocated memory for the thread name */
   AST_RWLIST_WRLOCK(&thread_list);
   AST_RWLIST_INSERT_HEAD(&thread_list, new, list);
   AST_RWLIST_UNLOCK(&thread_list);
}

void ast_set_default_eid

(

struct ast_eid *

eid

)

Fill in an ast_eid with the default eid of this machine.

Since:

1.6.1

Definition at line 235 of file netsock.c.

References ast_debug, ast_eid_to_str(), ast_eid::eid, and s.

Referenced by ast_readconfig().

{
#if defined(SIOCGIFHWADDR)
   int s, x = 0;
   char eid_str[20];
   struct ifreq ifr;

   s = socket(AF_INET, SOCK_STREAM, 0);
   if (s < 0)
      return;
   for (x = 0; x < 10; x++) {
      memset(&ifr, 0, sizeof(ifr));
      snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "eth%d", x);
      if (ioctl(s, SIOCGIFHWADDR, &ifr))
         continue;
      memcpy(eid, ((unsigned char *)&ifr.ifr_hwaddr) + 2, sizeof(*eid));
      ast_debug(1, "Seeding global EID '%s' from '%s' using 'siocgifhwaddr'\n", ast_eid_to_str(eid_str, sizeof(eid_str), eid), ifr.ifr_name);
      close(s);
      return;
   }
   close(s);
#else
#if defined(ifa_broadaddr) && !defined(SOLARIS)
   char eid_str[20];
   struct ifaddrs *ifap;
   
   if (getifaddrs(&ifap) == 0) {
      struct ifaddrs *p;
      for (p = ifap; p; p = p->ifa_next) {
         if ((p->ifa_addr->sa_family == AF_LINK) && !(p->ifa_flags & IFF_LOOPBACK) && (p->ifa_flags & IFF_RUNNING)) {
            struct sockaddr_dl* sdp = (struct sockaddr_dl*) p->ifa_addr;
            memcpy(&(eid->eid), sdp->sdl_data + sdp->sdl_nlen, 6);
            ast_debug(1, "Seeding global EID '%s' from '%s' using 'getifaddrs'\n", ast_eid_to_str(eid_str, sizeof(eid_str), eid), p->ifa_name);
            freeifaddrs(ifap);
            return;
         }
      }
      freeifaddrs(ifap);
   }
#endif
#endif
   ast_debug(1, "No ethernet interface found for seeding global EID. You will have to set it manually.\n");
}

void ast_sha1_hash	(	char *	output,
		char *	input
	)

Produces SHA1 hash based on input string.

Definition at line 246 of file utils.c.

References SHA1Input(), SHA1Reset(), and SHA1Result().

Referenced by aji_act_hook(), handle_call_token(), jabber_make_auth(), and sha1().

{
   struct SHA1Context sha;
   char *ptr;
   int x;
   uint8_t Message_Digest[20];

   SHA1Reset(&sha);
   
   SHA1Input(&sha, (const unsigned char *) input, strlen(input));

   SHA1Result(&sha, Message_Digest);
   ptr = output;
   for (x = 0; x < 20; x++)
      ptr += sprintf(ptr, "%2.2x", Message_Digest[x]);
}

static force_inline void ast_slinear_saturated_add	(	short *	input,
		short *	value
	)			[static]

Definition at line 271 of file utils.h.

Referenced by ast_frame_slinear_sum(), audio_audiohook_write_list(), and audiohook_read_frame_both().

{
   int res;

   res = (int) *input + *value;
   if (res > 32767)
      *input = 32767;
   else if (res < -32767)
      *input = -32767;
   else
      *input = (short) res;
}

static force_inline void ast_slinear_saturated_divide	(	short *	input,
		short *	value
	)			[static]

Definition at line 310 of file utils.h.

Referenced by ast_frame_adjust_volume(), and audiohook_read_frame_both().

{
   *input /= *value;
}

static force_inline void ast_slinear_saturated_multiply	(	short *	input,
		short *	value
	)			[static]

Definition at line 297 of file utils.h.

Referenced by ast_frame_adjust_volume(), and audiohook_read_frame_both().

{
   int res;

   res = (int) *input * *value;
   if (res > 32767)
      *input = 32767;
   else if (res < -32767)
      *input = -32767;
   else
      *input = (short) res;
}

static force_inline void ast_slinear_saturated_subtract	(	short *	input,
		short *	value
	)			[static]

Definition at line 284 of file utils.h.

{
   int res;

   res = (int) *input - *value;
   if (res > 32767)
      *input = 32767;
   else if (res < -32767)
      *input = -32767;
   else
      *input = (short) res;
}

int ast_str_to_eid	(	struct ast_eid *	eid,
		const char *	s
	)

Convert a string into an EID.

This function expects an EID in the format: 00:11:22:33:44:55

Returns:

0 success, non-zero failure

Since:

1.6.1

Definition at line 279 of file netsock.c.

References ast_eid::eid.

Referenced by ast_readconfig(), build_peer(), dundi_do_query(), and set_config().

{
   unsigned int eid_int[6];
   int x;

   if (sscanf(s, "%2x:%2x:%2x:%2x:%2x:%2x", &eid_int[0], &eid_int[1], &eid_int[2],
       &eid_int[3], &eid_int[4], &eid_int[5]) != 6)
         return -1;
   
   for (x = 0; x < 6; x++)
      eid->eid[x] = eid_int[x];

   return 0;
}

void ast_unregister_thread

(

void *

id

)

Definition at line 361 of file asterisk.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by dummy_start().

{
   struct thread_list_t *x;

   AST_RWLIST_WRLOCK(&thread_list);
   AST_RWLIST_TRAVERSE_SAFE_BEGIN(&thread_list, x, list) {
      if ((void *) x->id == id) {
         AST_RWLIST_REMOVE_CURRENT(list);
         break;
      }
   }
   AST_RWLIST_TRAVERSE_SAFE_END;
   AST_RWLIST_UNLOCK(&thread_list);
   if (x) {
      ast_free(x->name);
      ast_free(x);
   }
}

void ast_uri_decode

(

char *

s

)

Decode URI, URN, URL (overwrite string).

Parameters:

s

String to be decoded

Definition at line 414 of file utils.c.

Referenced by check_user_full(), config_curl(), get_also_info(), get_destination(), get_refer_info(), handle_request_invite(), http_decode(), realtime_curl(), realtime_multi_curl(), register_verify(), sip_new(), and uridecode().

{
   char *o;
   unsigned int tmp;

   for (o = s; *s; s++, o++) {
      if (*s == '%' && strlen(s) > 2 && sscanf(s + 1, "%2x", &tmp) == 1) {
         /* have '%', two chars and correct parsing */
         *o = tmp;
         s += 2;  /* Will be incremented once more when we break out */
      } else /* all other cases, just copy */
         *o = *s;
   }
   *o = '\0';
}

char* ast_uri_encode	(	const char *	string,
		char *	outbuf,
		int	buflen,
		int	doreserved
	)

Turn text string to URI-encoded XX version.

Note:

At this point, we're converting from ISO-8859-x (8-bit), not UTF8 as in the SIP protocol spec If doreserved == 1 we will convert reserved characters also. RFC 2396, section 2.4 outbuf needs to have more memory allocated than the instring to have room for the expansion. Every char that is converted is replaced by three ASCII characters.

Parameters:

	string	String to be converted
	outbuf	Resulting encoded string
	buflen	Size of output buffer
	doreserved	Convert reserved characters

Turn text string to URI-encoded XX version.

Note:

At this point, we're converting from ISO-8859-x (8-bit), not UTF8 as in the SIP protocol spec If doreserved == 1 we will convert reserved characters also. RFC 2396, section 2.4 outbuf needs to have more memory allocated than the instring to have room for the expansion. Every char that is converted is replaced by three ASCII characters.

Note: The doreserved option is needed for replaces header in SIP transfers.

Definition at line 383 of file utils.c.

References ast_copy_string(), and buf.

Referenced by config_curl(), destroy_curl(), initreqprep(), launch_asyncagi(), realtime_curl(), realtime_multi_curl(), require_curl(), store_curl(), update_curl(), and uriencode().

{
   char *reserved = ";/?:@&=+$,# "; /* Reserved chars */

   const char *ptr  = string; /* Start with the string */
   char *out = NULL;
   char *buf = NULL;

   ast_copy_string(outbuf, string, buflen);

   /* If there's no characters to convert, just go through and don't do anything */
   while (*ptr) {
      if ((*ptr < 32) || (doreserved && strchr(reserved, *ptr))) {
         /* Oops, we need to start working here */
         if (!buf) {
            buf = outbuf;
            out = buf + (ptr - string) ;  /* Set output ptr */
         }
         out += sprintf(out, "%%%02x", (unsigned char) *ptr);
      } else if (buf) {
         *out = *ptr;   /* Continue copying the string */
         out++;
      } 
      ptr++;
   }
   if (buf)
      *out = '\0';
   return outbuf;
}

int ast_utils_init

(

void

)

Definition at line 1860 of file utils.c.

References ARRAY_LEN, ast_cli_register_multiple(), and base64_init().

Referenced by main().

{
#ifdef HAVE_DEV_URANDOM
   dev_urandom_fd = open("/dev/urandom", O_RDONLY);
#endif
   base64_init();
#ifdef DEBUG_THREADS
#if !defined(LOW_MEMORY)
   ast_cli_register_multiple(utils_cli, ARRAY_LEN(utils_cli));
#endif
#endif
   return 0;
}

int ast_wait_for_input	(	int	fd,
		int	ms
	)

Definition at line 1051 of file utils.c.

References ast_poll.

Referenced by action_waitevent(), ast_tcptls_server_root(), dahdi_test_timer(), get_input(), and moh_class_destructor().

{
   struct pollfd pfd[1];
   memset(pfd, 0, sizeof(pfd));
   pfd[0].fd = fd;
   pfd[0].events = POLLIN|POLLPRI;
   return ast_poll(pfd, 1, ms);
}

---

Variable Documentation

unsigned int __unsigned_int_flags_dummy

Note:

   Note:
   It is very important to use only unsigned variables to hold
   bit flags, as otherwise you can fall prey to the compiler's
   sign-extension antics if you try to use the top two bits in
   your variable.

   The flag macros below use a set of compiler tricks to verify
   that the caller is using an "unsigned int" variable to hold
   the flags, and nothing else. If the caller uses any other
   type of variable, a warning message similar to this:

   warning: comparison of distinct pointer types lacks cast
   will be generated.

   The "dummy" variable below is used to make these comparisons.

   Also note that at -O2 or above, this type-safety checking
   does _not_ produce any additional object code at all.
 

uint64_t __unsigned_int_flags_dummy64

struct ast_eid ast_eid_default

Global EID.

This is set in asterisk.conf, or determined automatically by taking the mac address of an Ethernet interface on the system.

Definition at line 165 of file asterisk.c.

Referenced by ast_event_new(), ast_readconfig(), handle_show_settings(), pbx_retrieve_variable(), and set_config().