Mon Aug 31 12:30:46 2015

Asterisk developer's documentation


utils.h File Reference

Utility functions. More...

#include "asterisk/network.h"
#include <time.h>
#include <unistd.h>
#include <string.h>
#include "asterisk/lock.h"
#include "asterisk/logger.h"
#include "asterisk/localtime.h"
#include "asterisk/stringfields.h"
#include "asterisk/strings.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
struct  ast_http_digest

Defines

#define ARRAY_LEN(a)   (size_t) (sizeof(a) / sizeof(0[a]))
#define ast_align_for(offset, type)   (((offset + __alignof__(type) - 1) / __alignof__(type)) * __alignof__(type))
 Increase offset so it is a multiple of the required alignment of type.
#define ast_alignof(type)   __alignof__(type)
 Return the number of bytes used in the alignment of type.
#define ast_alloca(size)   __builtin_alloca(size)
 call __builtin_alloca to ensure we get gcc builtin semantics
#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_make_room_for(offset, type)   (((offset + (2 * __alignof__(type) - 1)) / __alignof__(type)) * __alignof__(type))
 Increase offset by the required alignment of type and make sure it is a multiple of said alignment.
#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);})
#define RAII_VAR(vartype, varname, initval, dtor)
 Declare a variable that will call a destructor function when it goes out of scope.

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.
void ast_do_crash (void)
 Force a crash if DO_CRASH is defined.
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.
char * ast_escape_quoted (const char *string, char *outbuf, int buflen)
 Escape characters found in a quoted string.
int ast_get_tid (void)
 Get current thread ID.
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, const char *input)
 Produces MD5 hash based on input string.
int ast_mkdir (const char *path, int mode)
 Recursively create directory path.
int ast_parse_digest (const char *digest, struct ast_http_digest *d, int request, int pedantic)
 Parse digest authorization header.
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, const 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_unescape_quoted (char *quote_str)
 Unescape quotes in a string.
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 do_special_char)
 Turn text string to URI-encoded XX version.
int ast_utils_init (void)
char * ast_utils_which (const char *binary, char *fullpath, size_t fullpath_size)
 Resolve a binary to a full pathname.
int ast_wait_for_input (int fd, int ms)
int ast_wait_for_output (int fd, int ms)
int ast_xml_escape (const char *string, char *outbuf, size_t buflen)
 Escape reserved characters for use in XML.

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 (  )     (size_t) (sizeof(a) / sizeof(0[a]))

Definition at line 699 of file utils.h.

#define ast_align_for ( offset,
type   )     (((offset + __alignof__(type) - 1) / __alignof__(type)) * __alignof__(type))

Increase offset so it is a multiple of the required alignment of type.

Parameters:
offset The value that should be increased.
type The data type that offset should be aligned to.
Returns:
The smallest multiple of alignof(type) larger than or equal to offset.
See also:
ast_make_room_for()

Many systems prefer integers to be stored on aligned on memory locations. This macro will increase an offset so a value of the supplied type can be safely be stored on such a memory location.

Examples: ast_align_for(0x17, int64_t) ==> 0x18 ast_align_for(0x18, int64_t) ==> 0x18 ast_align_for(0x19, int64_t) ==> 0x20

Don't mind the ugliness, the compiler will optimize it.

Definition at line 780 of file utils.h.

Referenced by __ast_string_field_ptr_build_va().

#define ast_alignof ( type   )     __alignof__(type)

Return the number of bytes used in the alignment of type.

Parameters:
type 
Returns:
The number of bytes required for alignment.

This is really just __alignof__(), but tucked away in this header so we don't have to look at the nasty underscores in the source.

Definition at line 760 of file utils.h.

Referenced by __ast_string_field_alloc_space(), and __ast_string_field_ptr_build_va().

#define ast_alloca ( size   )     __builtin_alloca(size)

call __builtin_alloca to ensure we get gcc builtin semantics

Parameters:
size The size of the buffer we want allocated

This macro will attempt to allocate memory from the stack. If it fails you won't get a NULL returned, but a SEGFAULT if you're lucky.

Definition at line 653 of file utils.h.

Referenced by __ast_verbose_ap(), _while_exec(), ael2_semantic_check(), aji_start_sasl(), alsa_card_init(), append_mailbox(), ast_control_streamfile(), ast_dsp_process(), ast_event_append_ie_str(), ast_event_check_subscriber(), ast_event_new(), ast_fileexists(), ast_lock_path_flock(), ast_lock_path_lockfile(), ast_mkdir(), ast_openstream_full(), ast_openvstream(), ast_pthread_create_detached_stack(), ast_pthread_create_stack(), ast_remotecontrol(), ast_say_counted_adjective(), ast_say_counted_noun(), ast_unlock_path_flock(), ast_unlock_path_lockfile(), ast_waitfor_nandfds(), ast_writefile(), astman_append_json(), builtin_automixmonitor(), builtin_automonitor(), callerid_feed(), callerid_feed_jp(), CB_ADD_LEN(), config_module(), cpeid_exec(), create_addr_from_peer(), cut_internal(), decode_frame(), dictate_exec(), dundi_decrypt(), dundi_encrypt(), dundi_precache_internal(), encrypt_frame(), feature_request_and_dial(), festival_exec(), find_table(), func_mchan_read(), function_fieldnum_helper(), function_fieldqty_helper(), handle_cli_config_reload(), handle_command_response(), handle_exec(), handle_memory_show_summary(), import_helper(), inprocess_count(), listfilter(), local_attended_transfer(), lua_get_variable(), lua_get_variable_value(), lua_read_extensions_file(), masquerade_colp_transfer(), mixmonitor_exec(), my_ast_get_channel_by_name_locked(), pbx_builtin_importvar(), pbx_load_module(), pbx_substitute_variables_helper_full(), queue_file(), realtime_exec(), replace(), shared_read(), shared_write(), shift_pop(), sip_addheader(), sms_generate(), socket_process(), sort_internal(), state_notify_build_xml(), static_callback(), try_firmware(), unshift_push(), vm_change_password(), vm_delete(), and vm_play_folder_name_gr().

#define ast_assert (  ) 
#define AST_BACKGROUND_STACKSIZE   AST_STACKSIZE

Definition at line 404 of file utils.h.

#define ast_clear_flag ( p,
flag   ) 

Definition at line 77 of file utils.h.

Referenced by __analog_ss_thread(), __ast_pbx_run(), __ast_read(), __do_deliver(), __transmit_response(), action_redirect(), aji_create_client(), aji_filter_roster(), aji_load_config(), analog_ss_thread(), ast_audiohook_set_mute(), ast_autoservice_stop(), ast_bridge_call(), ast_cdr_reset(), ast_cdr_specialized_reset(), ast_channel_bridge(), ast_channel_undefer_dtmf(), ast_do_masquerade(), ast_generic_bridge(), ast_jb_destroy(), ast_jb_put(), ast_rtp_raw_write(), ast_sendtext(), ast_settimeout_full(), ast_speech_start(), ast_tls_read_conf(), ast_translate(), ast_waitfor_nandfds(), ast_waitfordigit_full(), ast_write(), bridge_channel_feature(), bridge_p2p_rtp_write(), builtin_atxfer(), change_hold_state(), change_spy_mode(), channel_spy(), chanspy_exec(), check_goto_on_transfer(), check_pendings(), common_exec(), config_function_read(), config_text_file_load(), dahdi_read(), dahdiscan_exec(), deactivate_generator_nolock(), dial_exec_full(), dictate_exec(), disa_exec(), dundi_lookup_local(), extenspy_exec(), 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(), init_acf_query(), initialize_udptl(), linear_alloc(), load_config(), load_module(), load_moh_classes(), local_ast_moh_stop(), local_attended_transfer(), local_hangup(), main(), manage_parked_call(), manager_optimize_away(), odbc_load_module(), park_call_full(), parkandannounce_exec(), parse_options(), phone_read(), playtones_alloc(), process_sdp(), register_verify(), reload_config(), reset_transaction(), set_config(), set_config_flags(), setup_dahdi_int(), sip_call(), sip_dtmfmode(), sip_hangup(), sip_reload(), sip_set_rtp_peer(), socket_process(), speech_background(), try_calling(), update_call_counter(), update_connectedline(), and waitstream_core().

#define ast_clear_flag64 ( p,
flag   ) 
#define ast_clear_flag_nonstd ( p,
flag   ) 
Value:
do { \
               ((p)->flags &= ~(flag)); \
               } while(0)

Definition at line 180 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   ) 
#define ast_copy_flags64 ( dest,
src,
flagz   ) 
#define ast_copy_flags_nonstd ( dest,
src,
flagz   ) 
Value:
do { \
               (dest)->flags &= ~(flagz); \
               (dest)->flags |= ((src)->flags & (flagz)); \
               } while (0)

Definition at line 184 of file utils.h.

#define AST_FLAGS_ALL   UINT_MAX
#define ast_make_room_for ( offset,
type   )     (((offset + (2 * __alignof__(type) - 1)) / __alignof__(type)) * __alignof__(type))

Increase offset by the required alignment of type and make sure it is a multiple of said alignment.

Parameters:
offset The value that should be increased.
type The data type that room should be reserved for.
Returns:
The smallest multiple of alignof(type) larger than or equal to offset plus alignof(type).
See also:
ast_align_for()

A use case for this is when prepending length fields of type int to a buffer. If you keep the offset a multiple of the alignment of the integer type, a next block of length+buffer will have the length field automatically aligned.

Examples: ast_make_room_for(0x17, int64_t) ==> 0x20 ast_make_room_for(0x18, int64_t) ==> 0x20 ast_make_room_for(0x19, int64_t) ==> 0x28

Don't mind the ugliness, the compiler will optimize it.

Definition at line 803 of file utils.h.

Referenced by __ast_string_field_alloc_space(), and __ast_string_field_ptr_build_va().

#define ast_pthread_create ( a,
b,
c,
 ) 
#define ast_pthread_create_background ( a,
b,
c,
 ) 
#define ast_pthread_create_detached ( a,
b,
c,
 ) 
#define ast_pthread_create_detached_background ( a,
b,
c,
 ) 
#define ast_set2_flag ( p,
value,
flag   ) 
#define ast_set2_flag64 ( p,
value,
flag   ) 

Definition at line 151 of file utils.h.

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

#define ast_set2_flag_nonstd ( p,
value,
flag   ) 

Definition at line 189 of file utils.h.

#define ast_set_flag ( p,
flag   ) 

Definition at line 70 of file utils.h.

Referenced by __analog_ss_thread(), __ast_pbx_run(), __ast_read(), __ast_request_and_dial(), __sip_subscribe_mwi_do(), _macro_exec(), action_redirect(), aji_create_client(), aji_load_config(), analog_ss_thread(), app_exec(), apply_peer(), ast_audiohook_set_mute(), ast_autoservice_start(), ast_bridge_call(), ast_bridge_features_set_flag(), ast_bridge_new(), ast_bridge_timelimit(), 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_do_pickup(), ast_generic_bridge(), ast_hangup(), ast_jb_do_usecheck(), ast_jb_put(), ast_rtp_change_source(), ast_rtp_local_bridge(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_stop(), ast_rtp_update_source(), ast_settimeout_full(), ast_speech_change_state(), AST_TEST_DEFINE(), ast_tls_read_conf(), ast_waitfor_nandfds(), ast_waitfordigit_full(), asyncgoto_exec(), bridge_channel_feature(), bridge_exec(), bridge_p2p_rtp_write(), build_peer(), builtin_atxfer(), builtin_blindtransfer(), cb_extensionstate(), cc_generic_agent_init(), change_hold_state(), change_spy_mode(), channel_spy(), chanspy_exec(), check_bridge(), check_peer_ok(), check_user_full(), check_via(), common_exec(), create_addr_from_peer(), create_transaction(), dahdiscan_exec(), destroy_trans(), dial_exec_full(), dictate_exec(), directory_exec(), disa_exec(), do_register(), dundi_encrypt(), dundi_lookup_local(), dundi_send(), extenspy_exec(), find_peer(), find_user_realtime(), free_vm_users(), gosub_run(), handle_command_response(), handle_common_options(), handle_exec(), handle_gosub(), handle_invite_replaces(), handle_queue_reload(), handle_request_invite(), handle_request_refer(), handle_request_subscribe(), handle_response(), handle_response_invite(), handle_t38_options(), handle_verbose(), hangupcalls(), hanguptree(), init_acf_query(), init_app_class(), 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(), login_exec(), main(), manage_parked_call(), manager_queue_reload(), manager_sipnotify(), minivm_greet_exec(), new_outgoing(), nocdr_exec(), odbc_load_module(), park_call_full(), parked_call_exec(), parse_options(), playtones_alloc(), post_cdr(), process_applicationmap_line(), process_cn_rfc3389(), process_crypto(), process_sdp(), qualify_peer(), record_exec(), register_verify(), reload_config(), ring_entry(), set_bridge_features_on_config(), set_config_flags(), set_insecure_flags(), sip_answer(), sip_call(), sip_cc_agent_init(), sip_cc_agent_respond(), sip_cc_monitor_request_cc(), sip_cli_notify(), sip_dtmfmode(), sip_hangup(), sip_indicate(), sip_park_thread(), sip_poke_peer(), sip_reinvite_retry(), sip_send_mwi_to_peer(), sip_sendhtml(), sip_set_rtp_peer(), sip_set_udptl_peer(), sip_write(), socket_process(), start_spying(), tonepair_alloc(), transmit_publish(), transmit_register(), transmit_reinvite_with_sdp(), try_calling(), update_call_counter(), update_connectedline(), vm_execmain(), volume_write(), and waitstream_core().

#define ast_set_flag64 ( p,
flag   ) 
#define ast_set_flag_nonstd ( p,
flag   ) 
Value:
do { \
               ((p)->flags |= (flag)); \
               } while(0)

Definition at line 176 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 104 of file utils.h.

#define ast_set_flags_to64 ( p,
flag,
value   ) 

Definition at line 161 of file utils.h.

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

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

Definition at line 399 of file utils.h.

Referenced by ast_pthread_create_stack().

#define ast_strdupa (  ) 

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 stack allocated memory for the new string.

Definition at line 663 of file utils.h.

Referenced by __ast_channel_alloc_ap(), __ast_play_and_record(), __dahdi_exception(), _ast_device_state(), _build_port_config(), _macro_exec(), _parse(), _sip_show_peers_one(), _while_exec(), acf_jabberreceive_read(), acf_meetme_info(), acf_odbc_write(), action_agents(), action_status(), actual_load_config(), add_agent(), add_peer_mailboxes(), add_realm_authentication(), add_redirect(), add_var(), admin_exec(), advanced_options(), aelsub_exec(), agent_hangup(), agi_exec_full(), agi_handle_command(), aji_join_exec(), aji_leave_exec(), aji_send_exec(), aji_sendgroup_exec(), aji_status_exec(), analog_exception(), answer_exec_enable(), app_exec(), append_mailbox(), append_mailbox_mapping(), append_var_and_value_to_filter(), apply_directmedia_ha(), apply_options(), aqm_exec(), array(), ast_aji_get_client(), ast_app_getdata(), ast_append_ha(), ast_async_goto(), ast_bridge_call(), ast_bridge_timelimit(), ast_build_timing(), ast_callerid_split(), ast_cdr_fork(), ast_cdr_setaccount(), ast_cdr_setpeeraccount(), ast_cel_report_event(), ast_channel_connected_line_macro(), ast_channel_redirecting_macro(), ast_channel_set_linkgroup(), ast_data_iterator_init(), ast_do_pickup(), ast_eivr_senddtmf(), ast_eivr_setvariable(), ast_el_add_history(), ast_event_append_ie_str(), ast_event_sub_append_ie_str(), ast_filehelper(), ast_format_str_reduce(), ast_func_read(), ast_func_read2(), ast_func_write(), ast_get_group(), ast_masq_park_call(), ast_masq_park_call_exten(), ast_mkdir(), ast_monitor_change_fname(), ast_monitor_start(), ast_netsock_bind(), ast_ouraddrfor(), ast_park_call_exten(), ast_parse_allow_disallow(), ast_parse_arg(), ast_playtones_start(), ast_register_file_version(), ast_rtp_read(), ast_sockaddr_parse(), ast_sockaddr_resolve(), ast_str_retrieve_variable(), ast_utils_which(), ast_writefile(), asyncgoto_exec(), auth_exec(), authenticate_reply(), authenticate_verify(), background_detect_exec(), bridge_exec(), bridge_play_sounds(), build_channels(), build_gateway(), build_mapping(), build_peer(), build_profile(), build_route(), build_user(), builtin_atxfer(), builtin_automixmonitor(), builtin_automonitor(), cache_get_callno_locked(), callerid_read(), callerid_write(), celgenuserevent_exec(), chanavail_exec(), change_callid_pvt(), channel_admin_exec(), channel_spy(), chanspy_exec(), check_access(), check_blacklist(), check_day(), check_dow(), check_goto_on_transfer(), check_month(), check_peer_ok(), check_switch_expr(), check_timerange(), check_user_full(), cli_odbc_read(), cli_odbc_write(), complete_meetmecmd_list(), complete_meetmecmd_mute_kick(), conf_exec(), conf_run(), conf_start_moh(), confbridge_exec(), config_function_read(), config_line(), config_module(), connectedline_read(), connectedline_write(), controlplayback_exec(), count_exec(), create_addr(), create_addr_from_peer(), create_dynamic_parkinglot(), create_followme_number(), create_queue_member(), create_vmaccount(), cut_internal(), dahdiras_exec(), dahdiscan_exec(), data_filter_add_nodes(), data_filter_alloc(), data_filter_generate(), data_provider_create(), data_provider_release(), data_result_generate(), data_result_get_node(), data_search_create(), data_search_generate(), data_search_get_node(), decrypt_frame(), del_exec(), deltree_exec(), determine_starting_point(), dial_exec_full(), dial_trunk(), dialgroup_refreshdb(), dialgroup_write(), dictate_exec(), directory_exec(), disa_exec(), dnsmgr_refresh(), do_bridge_masquerade(), do_immediate_setup(), do_notify(), do_say(), dundi_query_read(), dundi_result_read(), dundifunc_read(), enum_query_read(), enum_result_read(), ewscal_write_event(), exec_exec(), execif_exec(), expand_gosub_args(), extenspy_exec(), feature_check(), feature_interpret(), festival_exec(), fileexists_core(), find_conf_realtime(), find_generic_monitor_instance_list(), find_gtalk(), find_sdp(), find_table(), find_table_cb(), forkcdr_exec(), function_agent(), function_iaxpeer(), function_realtime_store(), generic_recall(), get_cid_name(), get_destination(), get_refer_info(), gosub_exec(), gosub_run(), gosubif_exec(), gtalk_action(), gtalk_alloc(), gtalk_create_candidates(), gtalk_invite(), gtalk_request(), gtalk_update_externip(), handle_call_forward(), handle_cli_check_permissions(), handle_cli_dialplan_add_extension(), handle_cli_file_convert(), handle_common_options(), handle_debug_dialplan(), handle_gosub(), handle_mgcp_audit_endpoint(), handle_options(), handle_request_invite(), handle_request_notify(), handle_request_refer(), handle_response(), handle_show_dialplan(), handle_t38_options(), handle_verbose(), has_voicemail(), iax2_call(), iax2_devicestate(), iax2_prov_app(), iax2_request(), iconv_read(), init_acf_query(), init_jack_data(), insert_penaltychange(), is_prefix(), is_valid_dtmf(), isAnsweringMachine(), isexten_function_read(), ivr_dispatch(), jingle_request(), launch_ha_netscript(), launch_monitor_thread(), launch_netscript(), leave_voicemail(), load_channelvars(), load_config(), load_dynamic_module(), local_call(), local_devicestate(), log_exec(), logger_print_normal(), login_exec(), lua_get_variable_value(), lua_pbx_exec(), lua_set_variable_value(), macroif_exec(), main(), make_components(), make_email_file(), man_do_variable_value(), manage_parked_call(), match_ie_val(), match_sub_ie_val_to_event(), meetmemute(), metermaidstate(), mgcp_devicestate(), minivm_accmess_exec(), minivm_account_func_read(), minivm_counter_func_read(), minivm_counter_func_write(), minivm_greet_exec(), minivm_mwi_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(), multicast_rtp_request(), notify_message(), notify_new_message(), odbc_log(), on_dns_update_mwi(), on_dns_update_peer(), on_dns_update_registry(), orig_app(), orig_exten(), originate_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), page_exec(), park_call_exec(), park_space_reserve(), parkandannounce_exec(), parked_call_exec(), parse_allowed_methods(), parse_apps(), parse_cookies(), parse_empty_options(), parse_events(), parse_register_contact(), parse_session_expires(), parse_sip_options(), parse_uri_full(), party_id_write(), party_name_write(), party_number_write(), pbx_builtin_answer(), 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_extension_helper(), pbx_find_extension(), pbx_parseable_goto(), peer_set_srcaddr(), pickup_exec(), pickupchan_exec(), play_message(), play_moh_exec(), playback_exec(), pqm_exec(), prep_email_sub_vars(), privacy_exec(), process_applicationmap_line(), process_dahdi(), process_echocancel(), process_sdp(), process_sdp_a_image(), process_sdp_o(), proxy_from_config(), 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_ldap(), realtime_multi_odbc(), realtime_multi_pgsql(), receivefax_exec(), record_exec(), redirecting_read(), redirecting_write(), register_verify(), registry_authrequest(), reload_config(), reload_followme(), reload_single_member(), resource_name_match(), retrydial_exec(), rqm_exec(), rtcp_do_debug_ip(), rtp_do_debug_ip(), saycountedadj_exec(), saycountednoun_exec(), sayunixtime_exec(), sdp_crypto_process(), senddtmf_exec(), sendfax_exec(), sendmail(), sendurl_exec(), set_config_flags(), set_hangup_source_and_cause(), setup_privacy_args(), setup_stunaddr(), sip_acf_channel_read(), sip_devicestate(), sip_get_cc_information(), sip_new(), sip_queue_hangup_cause(), sip_send_mwi_to_peer(), sip_show_settings(), sip_sipredirect(), sip_uri_cmp(), sip_uri_headers_cmp(), sip_uri_params_cmp(), skel_exec(), 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(), srv_result_read(), stackpeek_read(), start_moh_exec(), start_monitor_action(), start_monitor_exec(), state_notify_build_xml(), stun_monitor_request(), timezone_add(), transfer_exec(), transmit_invite(), 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(), vmsayname_exec(), wait_for_answer(), wait_for_winner(), waitstream_core(), xfer_park_call_helper(), xmldoc_get_syntax_fun(), and zapateller_exec().

#define ast_test_flag ( p,
flag   ) 

Definition at line 63 of file utils.h.

Referenced by __ast_channel_masquerade(), __ast_pbx_run(), __ast_queue_frame(), __ast_read(), __sip_destroy(), __ssl_setup(), __transmit_response(), _ast_odbc_request_obj2(), _macro_exec(), _sip_show_peer(), _sip_show_peers_one(), acf_odbc_read(), action_login(), add_agent(), add_codec_to_sdp(), add_rpid(), add_sdp(), aji_build_publish_skeleton(), aji_cli_purge_pubsub_nodes(), aji_create_client(), aji_handle_pubsub_error(), aji_handle_subscribe(), aji_pruneregister(), aji_publish_device_state(), aji_pubsub_subscribe(), app_exec(), ast_audiohook_write_frame(), ast_autoservice_start(), ast_bridge_call(), ast_bridge_end_dtmf(), ast_bridge_merge(), ast_call(), ast_can_pickup(), 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_setpeeraccount(), ast_cdr_setuserfield(), ast_cdr_setvar(), ast_cdr_specialized_reset(), ast_cdr_start(), ast_cdr_update(), ast_channel_bridge(), ast_channel_defer_dtmf(), ast_config_internal_load(), ast_do_masquerade(), ast_explicit_goto(), ast_frisolate(), ast_generic_bridge(), 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_LIST_HEAD_NOLOCK(), ast_moh_files_next(), ast_pbx_run_args(), ast_pbx_start(), ast_quiet_chan(), ast_raw_answer(), ast_readstring_full(), ast_rtp_raw_write(), ast_sendtext(), ast_settimeout_full(), ast_softhangup_nolock(), ast_streamfile(), AST_TEST_DEFINE(), ast_transfer(), ast_translate(), ast_waitfordigit_full(), ast_write(), auth_exec(), authenticate_verify(), bridge_channel_join(), bridge_check_dissolve(), bridge_exec(), bridge_p2p_rtp_write(), build_peer(), build_radius_record(), build_via(), builtin_atxfer(), call_forward_inherit(), callback_dialoptions(), cb_extensionstate(), cdr_read(), cdr_write(), change_hold_state(), channel_data_add_flags(), channel_spy(), chanspy_exec(), 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(), confbridge_exec(), config_text_file_load(), connectedline_write(), controlplayback_exec(), copy_via_headers(), create_addr_from_peer(), create_jb(), destroy_trans(), dial_exec_full(), dialog_initialize_rtp(), dictate_exec(), directory_exec(), disa_exec(), display_nat_warning(), do_directory(), do_setnat(), 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(), enable_dsp_detect(), execute_cb(), expire_register(), extenspy_exec(), feature_exec_app(), feature_interpret_helper(), find_cache(), find_or_create(), find_user(), find_user_realtime(), forkcdr_exec(), forward_message(), free_user(), function_sippeer(), get_destination(), get_insecure_variable_from_config(), get_insecure_variable_from_sipregs(), get_rpid(), get_sip_pvt_byid_locked(), gosub_exec(), gosub_run(), handle_cli_moh_show_classes(), handle_cli_wait_fullybooted(), handle_command_response(), handle_exec(), handle_frame(), handle_gosub(), handle_incoming(), 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_write(), initialize_udptl(), initreqprep(), interpret_t38_parameters(), is_state_change_valid(), join_conference_bridge(), leave_conference_bridge(), leave_voicemail(), load_dynamic_module(), load_resource(), local_alloc(), local_ast_moh_start(), local_bridgedchannel(), local_call(), local_devicestate(), local_hangup(), local_indicate(), local_write(), main(), make_email_file(), manager_list_voicemail_users(), masq_park_call(), match_req_to_dialog(), menu_callback(), 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(), multicast_rtp_write(), notify_new_message(), odbc_load_module(), page_exec(), park_call_exec(), park_call_full(), 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(), post_join_marked(), post_join_unmarked(), precache_transactions(), process_cn_rfc3389(), process_crypto(), process_sdp(), process_sdp_a_audio(), process_sdp_o(), process_text_line(), read_exec(), readexten_exec(), realtime_peer(), realtime_switch_common(), receivefax_exec(), record_exec(), redirecting_write(), reload_config(), reload_handler(), reload_queues(), reload_single_queue(), remote_bridge_loop(), remove_from_queue(), reqprep(), respprep(), retrans_pkt(), retrydial_exec(), return_exec(), select_entry(), select_item_pause(), send_request(), sendfax_exec(), sendmail(), sendurl_exec(), serialize_showchan(), set_address_from_contact(), set_config_flags(), set_pvt_allowed_methods(), set_t38_capabilities(), should_skip_dtmf(), show_channels_cb(), sip_alloc(), sip_answer(), sip_call(), sip_cc_agent_destructor(), sip_destroy_peer(), 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_setoption(), sip_show_channel(), sip_show_settings(), 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_invite(), transmit_notify_with_mwi(), transmit_refer(), transmit_reinvite_with_sdp(), transmit_request_with_auth(), transmit_response_with_sdp(), transmit_state_notify(), try_calling(), update_call_counter(), update_connectedline(), update_peer(), update_redirecting(), update_registry(), vm_exec(), vm_execmain(), vm_instructions_en(), vm_intro(), vm_newuser(), volume_callback(), wait_for_winner(), waitstream_core(), and xfer_park_call_helper().

#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__

Definition at line 359 of file utils.h.

#define MAX ( a,
 )     ({ typeof(a) __a = (a); typeof(b) __b = (b); ((__a < __b) ? __b : __a);})
#define MIN ( a,
 )     ({ typeof(a) __a = (a); typeof(b) __b = (b); ((__a > __b) ? __b : __a);})
#define RAII_VAR ( vartype,
varname,
initval,
dtor   ) 
Value:
/* Prototype needed due to http://gcc.gnu.org/bugzilla/show_bug.cgi?id=36774 */ \
    auto void _dtor_ ## varname (vartype * v); \
    void _dtor_ ## varname (vartype * v) { dtor(*v); } \
    vartype varname __attribute__((cleanup(_dtor_ ## varname))) = (initval)

Declare a variable that will call a destructor function when it goes out of scope.

Resource Allocation Is Initialization (RAII) variable declaration.

Since:
1.8.24.0
Parameters:
vartype The type of the variable
varname The name of the variable
initval The initial value of the variable
dtor The destructor function of type' void func(vartype *)'
 void mything_cleanup(struct mything *t)
 {
     if (t) {
         ast_free(t->stuff);
     }
 }

 void do_stuff(const char *name)
 {
     RAII_VAR(struct mything *, thing, mything_alloc(name), mything_cleanup);
     ...
 }
Note:
This macro is especially useful for working with ao2 objects. A common idiom would be a function that needed to look up an ao2 object and might have several error conditions after the allocation that would normally need to unref the ao2 object. With RAII_VAR, it is possible to just return and leave the cleanup to the destructor function. For example:
 void do_stuff(const char *name)
 {
     RAII_VAR(struct mything *, thing, find_mything(name), ao2_cleanup);
     if (!thing) {
         return;
     }
     if (error) {
         return;
     }
     do_stuff_with_thing(thing);
 }

Definition at line 915 of file utils.h.

Referenced by check_user_full(), config_pgsql(), destroy_pgsql(), dial_trunk(), find_table(), get_destination(), realtime_multi_pgsql(), realtime_pgsql(), replace(), run_station(), sla_add_trunk_to_station(), sla_build_station(), sla_build_trunk(), sla_check_station_delay(), sla_handle_dial_state_event(), sla_state(), sla_station_exec(), sla_trunk_exec(), store_pgsql(), update2_pgsql(), and update_pgsql().


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 279 of file utils.c.

Referenced by aes_helper(), ast_check_signature(), base64_helper(), osp_validate_token(), sdp_crypto_process(), and sdp_crypto_setup().

00280 {
00281    int cnt = 0;
00282    unsigned int byte = 0;
00283    unsigned int bits = 0;
00284    int incnt = 0;
00285    while(*src && *src != '=' && (cnt < max)) {
00286       /* Shift in 6 bits of input */
00287       byte <<= 6;
00288       byte |= (b2a[(int)(*src)]) & 0x3f;
00289       bits += 6;
00290       src++;
00291       incnt++;
00292       /* If we have at least 8 bits left over, take that character 
00293          off the top */
00294       if (bits >= 8)  {
00295          bits -= 8;
00296          *dst = (byte >> bits) & 0xff;
00297          dst++;
00298          cnt++;
00299       }
00300    }
00301    /* Don't worry about left over bits, they're extra anyway */
00302    return cnt;
00303 }

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 357 of file utils.c.

References ast_base64encode_full().

Referenced by aes_helper(), aji_start_sasl(), ast_sign(), base64_helper(), build_secret(), osp_check_destination(), and sdp_crypto_setup().

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

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

encode text to BASE64 coding

Definition at line 306 of file utils.c.

Referenced by ast_base64encode().

00307 {
00308    int cnt = 0;
00309    int col = 0;
00310    unsigned int byte = 0;
00311    int bits = 0;
00312    int cntin = 0;
00313    /* Reserve space for null byte at end of string */
00314    max--;
00315    while ((cntin < srclen) && (cnt < max)) {
00316       byte <<= 8;
00317       byte |= *(src++);
00318       bits += 8;
00319       cntin++;
00320       if ((bits == 24) && (cnt + 4 <= max)) {
00321          *dst++ = base64[(byte >> 18) & 0x3f];
00322          *dst++ = base64[(byte >> 12) & 0x3f];
00323          *dst++ = base64[(byte >> 6) & 0x3f];
00324          *dst++ = base64[byte & 0x3f];
00325          cnt += 4;
00326          col += 4;
00327          bits = 0;
00328          byte = 0;
00329       }
00330       if (linebreaks && (cnt < max) && (col == 64)) {
00331          *dst++ = '\n';
00332          cnt++;
00333          col = 0;
00334       }
00335    }
00336    if (bits && (cnt + 4 <= max)) {
00337       /* Add one last character for the remaining bits, 
00338          padding the rest with 0 */
00339       byte <<= 24 - bits;
00340       *dst++ = base64[(byte >> 18) & 0x3f];
00341       *dst++ = base64[(byte >> 12) & 0x3f];
00342       if (bits == 16)
00343          *dst++ = base64[(byte >> 6) & 0x3f];
00344       else
00345          *dst++ = '=';
00346       *dst++ = '=';
00347       cnt += 4;
00348    }
00349    if (linebreaks && (cnt < max)) {
00350       *dst++ = '\n';
00351       cnt++;
00352    }
00353    *dst = '\0';
00354    return cnt;
00355 }

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 1369 of file utils.c.

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

Referenced by send_string().

01370 {
01371    struct timeval start = ast_tvnow();
01372    int n = 0;
01373    int elapsed = 0;
01374 
01375    while (len) {
01376       if (wait_for_output(fd, timeoutms - elapsed)) {
01377          /* poll returned a fatal error, so bail out immediately. */
01378          return -1;
01379       }
01380 
01381       /* Clear any errors from a previous write */
01382       clearerr(f);
01383 
01384       n = fwrite(src, 1, len, f);
01385 
01386       if (ferror(f) && errno != EINTR && errno != EAGAIN) {
01387          /* fatal error from fwrite() */
01388          if (!feof(f)) {
01389             /* Don't spam the logs if it was just that the connection is closed. */
01390             ast_log(LOG_ERROR, "fwrite() returned error: %s\n", strerror(errno));
01391          }
01392          n = -1;
01393          break;
01394       }
01395 
01396       /* Update for data already written to the socket */
01397       len -= n;
01398       src += n;
01399 
01400       elapsed = ast_tvdiff_ms(ast_tvnow(), start);
01401       if (elapsed >= timeoutms) {
01402          /* We've taken too long to write 
01403           * This is only an error condition if we haven't finished writing. */
01404          n = len ? -1 : 0;
01405          break;
01406       }
01407    }
01408 
01409    errno = 0;
01410    while (fflush(f)) {
01411       if (errno == EAGAIN || errno == EINTR) {
01412          /* fflush() does not appear to reset errno if it flushes
01413           * and reaches EOF at the same time. It returns EOF with
01414           * the last seen value of errno, causing a possible loop.
01415           * Also usleep() to reduce CPU eating if it does loop */
01416          errno = 0;
01417          usleep(1);
01418          continue;
01419       }
01420       if (errno && !feof(f)) {
01421          /* Don't spam the logs if it was just that the connection is closed. */
01422          ast_log(LOG_ERROR, "fflush() returned error: %s\n", strerror(errno));
01423       }
01424       n = -1;
01425       break;
01426    }
01427 
01428    return n < 0 ? -1 : 0;
01429 }

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 1328 of file utils.c.

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

Referenced by ast_agi_send(), and ast_cli().

01329 {
01330    struct timeval start = ast_tvnow();
01331    int res = 0;
01332    int elapsed = 0;
01333 
01334    while (len) {
01335       if (wait_for_output(fd, timeoutms - elapsed)) {
01336          return -1;
01337       }
01338 
01339       res = write(fd, s, len);
01340 
01341       if (res < 0 && errno != EAGAIN && errno != EINTR) {
01342          /* fatal error from write() */
01343          ast_log(LOG_ERROR, "write() returned error: %s\n", strerror(errno));
01344          return -1;
01345       }
01346 
01347       if (res < 0) {
01348          /* It was an acceptable error */
01349          res = 0;
01350       }
01351 
01352       /* Update how much data we have left to write */
01353       len -= res;
01354       s += res;
01355       res = 0;
01356 
01357       elapsed = ast_tvdiff_ms(ast_tvnow(), start);
01358       if (elapsed >= timeoutms) {
01359          /* We've taken too long to write 
01360           * This is only an error condition if we haven't finished writing. */
01361          res = len ? -1 : 0;
01362          break;
01363       }
01364    }
01365 
01366    return res;
01367 }

void ast_do_crash ( void   ) 

Force a crash if DO_CRASH is defined.

Note:
If DO_CRASH is not defined then the function returns.
Returns:
Nothing

Definition at line 2382 of file utils.c.

Referenced by my_do_crash().

02383 {
02384 #if defined(DO_CRASH)
02385    abort();
02386    /*
02387     * Just in case abort() doesn't work or something else super
02388     * silly, and for Qwell's amusement.
02389     */
02390    *((int *) 0) = 0;
02391 #endif   /* defined(DO_CRASH) */
02392 }

int ast_eid_cmp ( const struct ast_eid eid1,
const struct ast_eid eid2 
)
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 222 of file netsock.c.

References ast_eid::eid.

Referenced by aji_publish_device_state(), aji_publish_mwi(), append_transaction(), ast_set_default_eid(), ast_str_retrieve_variable(), 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(), dump_raw_ie(), 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(), populate_addr(), register_request(), and update_key().

00223 {
00224    int x;
00225    char *os = s;
00226    if (maxlen < 18) {
00227       if (s && (maxlen > 0))
00228          *s = '\0';
00229    } else {
00230       for (x = 0; x < 5; x++) {
00231          sprintf(s, "%02x:", (unsigned)eid->eid[x]);
00232          s += 3;
00233       }
00234       sprintf(s, "%02x", (unsigned)eid->eid[5]);
00235    }
00236    return os;
00237 }

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 2141 of file utils.c.

References ast_log(), and LOG_WARNING.

Referenced by ast_netsock_bindaddr(), and reload_config().

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

char* ast_escape_quoted ( const char *  string,
char *  outbuf,
int  buflen 
)

Escape characters found in a quoted string.

Note:
This function escapes quoted characters based on the 'qdtext' set of allowed characters from RFC 3261 section 25.1.
Parameters:
string string to be escaped
outbuf resulting escaped string
buflen size of output buffer
Returns:
a pointer to the escaped string

Definition at line 431 of file utils.c.

Referenced by add_diversion_header(), add_rpid(), ast_callerid_merge(), and initreqprep().

00432 {
00433    const char *ptr  = string;
00434    char *out = outbuf;
00435    char *allow = "\t\v !"; /* allow LWS (minus \r and \n) and "!" */
00436 
00437    while (*ptr && out - outbuf < buflen - 1) {
00438       if (!(strchr(allow, *ptr))
00439          && !(*ptr >= '#' && *ptr <= '[') /* %x23 - %x5b */
00440          && !(*ptr >= ']' && *ptr <= '~') /* %x5d - %x7e */
00441          && !((unsigned char) *ptr > 0x7f)) {             /* UTF8-nonascii */
00442 
00443          if (out - outbuf >= buflen - 2) {
00444             break;
00445          }
00446          out += sprintf(out, "\\%c", (unsigned char) *ptr);
00447       } else {
00448          *out = *ptr;
00449          out++;
00450       }
00451       ptr++;
00452    }
00453 
00454    if (buflen) {
00455       *out = '\0';
00456    }
00457 
00458    return outbuf;
00459 }

int ast_get_tid ( void   ) 

Get current thread ID.

Since:
1.8.28.0
Returns:
the ID if platform is supported, else -1

Definition at line 2346 of file utils.c.

Referenced by __ao2_alloc_debug(), __ao2_ref_debug(), and ast_log().

02347 {
02348    int ret = -1;
02349 #if defined (__linux) && defined(SYS_gettid)
02350    ret = syscall(SYS_gettid); /* available since Linux 1.4.11 */
02351 #elif defined(__sun)
02352    ret = pthread_self();
02353 #elif defined(__APPLE__)
02354    ret = mach_thread_self();
02355    mach_port_deallocate(mach_task_self(), ret);
02356 #elif defined(__FreeBSD__) && defined(HAVE_SYS_THR_H)
02357    long lwpid;
02358    thr_self(&lwpid); /* available since sys/thr.h creation 2003 */
02359    ret = lwpid;
02360 #endif
02361    return ret;
02362 }

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

Thread-safe gethostbyname function to use in Asterisk.

Definition at line 195 of file utils.c.

References ast_hostent::buf, and ast_hostent::hp.

Referenced by __ast_http_load(), app_exec(), ast_parse_arg(), build_peer(), config_load(), config_parse_variables(), create_addr(), festival_exec(), gtalk_load_config(), gtalk_update_stun(), iax_template_parse(), jingle_load_config(), jingle_update_stun(), launch_netscript(), process_sdp(), realtime_peer(), realtime_user(), reload_config(), and set_config().

00196 {
00197    int res;
00198    int herrno;
00199    int dots = 0;
00200    const char *s;
00201    struct hostent *result = NULL;
00202    /* Although it is perfectly legitimate to lookup a pure integer, for
00203       the sake of the sanity of people who like to name their peers as
00204       integers, we break with tradition and refuse to look up a
00205       pure integer */
00206    s = host;
00207    res = 0;
00208    while (s && *s) {
00209       if (*s == '.')
00210          dots++;
00211       else if (!isdigit(*s))
00212          break;
00213       s++;
00214    }
00215    if (!s || !*s) {
00216       /* Forge a reply for IP's to avoid octal IP's being interpreted as octal */
00217       if (dots != 3)
00218          return NULL;
00219       memset(hp, 0, sizeof(struct ast_hostent));
00220       hp->hp.h_addrtype = AF_INET;
00221       hp->hp.h_addr_list = (void *) hp->buf;
00222       hp->hp.h_addr = hp->buf + sizeof(void *);
00223       /* For AF_INET, this will always be 4 */
00224       hp->hp.h_length = 4;
00225       if (inet_pton(AF_INET, host, hp->hp.h_addr) > 0)
00226          return &hp->hp;
00227       return NULL;
00228       
00229    }
00230 #ifdef HAVE_GETHOSTBYNAME_R_5
00231    result = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &herrno);
00232 
00233    if (!result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
00234       return NULL;
00235 #else
00236    res = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &result, &herrno);
00237 
00238    if (res || !result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
00239       return NULL;
00240 #endif
00241    return &hp->hp;
00242 }

void ast_md5_hash ( char *  output,
const char *  input 
)

Produces MD5 hash based on input string.

Definition at line 245 of file utils.c.

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

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

00246 {
00247    struct MD5Context md5;
00248    unsigned char digest[16];
00249    char *ptr;
00250    int x;
00251 
00252    MD5Init(&md5);
00253    MD5Update(&md5, (const unsigned char *) input, strlen(input));
00254    MD5Final(digest, &md5);
00255    ptr = output;
00256    for (x = 0; x < 16; x++)
00257       ptr += sprintf(ptr, "%2.2x", (unsigned)digest[x]);
00258 }

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 2151 of file utils.c.

References ast_alloca, ast_strdupa, errno, and len().

Referenced by ast_monitor_change_fname(), ast_monitor_start(), conf_run(), create_dirpath(), dictate_exec(), filename_parse(), 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().

02152 {
02153    char *ptr;
02154    int len = strlen(path), count = 0, x, piececount = 0;
02155    char *tmp = ast_strdupa(path);
02156    char **pieces;
02157    char *fullpath = ast_alloca(len + 1);
02158    int res = 0;
02159 
02160    for (ptr = tmp; *ptr; ptr++) {
02161       if (*ptr == '/')
02162          count++;
02163    }
02164 
02165    /* Count the components to the directory path */
02166    pieces = ast_alloca(count * sizeof(*pieces));
02167    for (ptr = tmp; *ptr; ptr++) {
02168       if (*ptr == '/') {
02169          *ptr = '\0';
02170          pieces[piececount++] = ptr + 1;
02171       }
02172    }
02173 
02174    *fullpath = '\0';
02175    for (x = 0; x < piececount; x++) {
02176       /* This looks funky, but the buffer is always ideally-sized, so it's fine. */
02177       strcat(fullpath, "/");
02178       strcat(fullpath, pieces[x]);
02179       res = mkdir(fullpath, mode);
02180       if (res && errno != EEXIST)
02181          return errno;
02182    }
02183    return 0;
02184 }

int ast_parse_digest ( const char *  digest,
struct ast_http_digest d,
int  request,
int  pedantic 
)

Parse digest authorization header.

Returns:
Returns -1 if we have no auth or something wrong with digest.
Note:
This function may be used for Digest request and responce header. request arg is set to nonzero, if we parse Digest Request. pedantic arg can be set to nonzero if we need to do addition Digest check.

Definition at line 2216 of file utils.c.

References ast_free, ast_log(), ast_skip_blanks(), ast_str_buffer(), ast_str_create(), ast_str_set(), ast_string_field_ptr_set, ast_string_field_set, ast_strlen_zero(), ast_unescape_c(), ast_http_digest::cnonce, ast_http_digest::domain, LOG_WARNING, ast_http_digest::nc, ast_http_digest::nonce, ast_http_digest::opaque, ast_http_digest::qop, ast_http_digest::realm, ast_http_digest::response, ast_http_digest::uri, and ast_http_digest::username.

Referenced by auth_http_callback().

02216                                                                                                {
02217    char *c;
02218    struct ast_str *str = ast_str_create(16);
02219 
02220    /* table of recognised keywords, and places where they should be copied */
02221    const struct x {
02222       const char *key;
02223       const ast_string_field *field;
02224    } *i, keys[] = {
02225       { "username=", &d->username },
02226       { "realm=", &d->realm },
02227       { "nonce=", &d->nonce },
02228       { "uri=", &d->uri },
02229       { "domain=", &d->domain },
02230       { "response=", &d->response },
02231       { "cnonce=", &d->cnonce },
02232       { "opaque=", &d->opaque },
02233       /* Special cases that cannot be directly copied */
02234       { "algorithm=", NULL },
02235       { "qop=", NULL },
02236       { "nc=", NULL },
02237       { NULL, 0 },
02238    };
02239 
02240    if (ast_strlen_zero(digest) || !d || !str) {
02241       ast_free(str);
02242       return -1;
02243    }
02244 
02245    ast_str_set(&str, 0, "%s", digest);
02246 
02247    c = ast_skip_blanks(ast_str_buffer(str));
02248 
02249    if (strncasecmp(c, "Digest ", strlen("Digest "))) {
02250       ast_log(LOG_WARNING, "Missing Digest.\n");
02251       ast_free(str);
02252       return -1;
02253    }
02254    c += strlen("Digest ");
02255 
02256    /* lookup for keys/value pair */
02257    while (c && *c && *(c = ast_skip_blanks(c))) {
02258       /* find key */
02259       for (i = keys; i->key != NULL; i++) {
02260          char *src, *separator;
02261          int unescape = 0;
02262          if (strncasecmp(c, i->key, strlen(i->key)) != 0) {
02263             continue;
02264          }
02265 
02266          /* Found. Skip keyword, take text in quotes or up to the separator. */
02267          c += strlen(i->key);
02268          if (*c == '"') {
02269             src = ++c;
02270             separator = "\"";
02271             unescape = 1;
02272          } else {
02273             src = c;
02274             separator = ",";
02275          }
02276          strsep(&c, separator); /* clear separator and move ptr */
02277          if (unescape) {
02278             ast_unescape_c(src);
02279          }
02280          if (i->field) {
02281             ast_string_field_ptr_set(d, i->field, src);
02282          } else {
02283             /* Special cases that require additional procesing */
02284             if (!strcasecmp(i->key, "algorithm=")) {
02285                if (strcasecmp(src, "MD5")) {
02286                   ast_log(LOG_WARNING, "Digest algorithm: \"%s\" not supported.\n", src);
02287                   ast_free(str);
02288                   return -1;
02289                }
02290             } else if (!strcasecmp(i->key, "qop=") && !strcasecmp(src, "auth")) {
02291                d->qop = 1;
02292             } else if (!strcasecmp(i->key, "nc=")) {
02293                unsigned long u;
02294                if (sscanf(src, "%30lx", &u) != 1) {
02295                   ast_log(LOG_WARNING, "Incorrect Digest nc value: \"%s\".\n", src);
02296                   ast_free(str);
02297                   return -1;
02298                }
02299                ast_string_field_set(d, nc, src);
02300             }
02301          }
02302          break;
02303       }
02304       if (i->key == NULL) { /* not found, try ',' */
02305          strsep(&c, ",");
02306       }
02307    }
02308    ast_free(str);
02309 
02310    /* Digest checkout */
02311    if (ast_strlen_zero(d->realm) || ast_strlen_zero(d->nonce)) {
02312       /* "realm" and "nonce" MUST be always exist */
02313       return -1;
02314    }
02315 
02316    if (!request) {
02317       /* Additional check for Digest response */
02318       if (ast_strlen_zero(d->username) || ast_strlen_zero(d->uri) || ast_strlen_zero(d->response)) {
02319          return -1;
02320       }
02321 
02322       if (pedantic && d->qop && (ast_strlen_zero(d->cnonce) || ast_strlen_zero(d->nc))) {
02323          return -1;
02324       }
02325    }
02326 
02327    return 0;
02328 }

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 1664 of file utils.c.

01665 {
01666    char *dataPut = start;
01667    int inEscape = 0;
01668    int inQuotes = 0;
01669 
01670    for (; *start; start++) {
01671       if (inEscape) {
01672          *dataPut++ = *start;       /* Always goes verbatim */
01673          inEscape = 0;
01674       } else {
01675          if (*start == '\\') {
01676             inEscape = 1;      /* Do not copy \ into the data */
01677          } else if (*start == '\'') {
01678             inQuotes = 1 - inQuotes;   /* Do not copy ' into the data */
01679          } else {
01680             /* Replace , with |, unless in quotes */
01681             *dataPut++ = inQuotes ? *start : ((*start == find) ? replace_with : *start);
01682          }
01683       }
01684    }
01685    if (start != dataPut)
01686       *dataPut = 0;
01687    return dataPut;
01688 }

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 1230 of file utils.c.

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

01233 {
01234    unsigned char attr_destroy = 0;
01235    int res;
01236 
01237    if (!attr) {
01238       attr = ast_alloca(sizeof(*attr));
01239       pthread_attr_init(attr);
01240       attr_destroy = 1;
01241    }
01242 
01243    if ((errno = pthread_attr_setdetachstate(attr, PTHREAD_CREATE_DETACHED)))
01244       ast_log(LOG_WARNING, "pthread_attr_setdetachstate: %s\n", strerror(errno));
01245 
01246    res = ast_pthread_create_stack(thread, attr, start_routine, data, 
01247                                   stacksize, file, caller, line, start_fn);
01248 
01249    if (attr_destroy)
01250       pthread_attr_destroy(attr);
01251 
01252    return res;
01253 }

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 1182 of file utils.c.

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

01185 {
01186 #if !defined(LOW_MEMORY)
01187    struct thr_arg *a;
01188 #endif
01189 
01190    if (!attr) {
01191       attr = ast_alloca(sizeof(*attr));
01192       pthread_attr_init(attr);
01193    }
01194 
01195 #ifdef __linux__
01196    /* On Linux, pthread_attr_init() defaults to PTHREAD_EXPLICIT_SCHED,
01197       which is kind of useless. Change this here to
01198       PTHREAD_INHERIT_SCHED; that way the -p option to set realtime
01199       priority will propagate down to new threads by default.
01200       This does mean that callers cannot set a different priority using
01201       PTHREAD_EXPLICIT_SCHED in the attr argument; instead they must set
01202       the priority afterwards with pthread_setschedparam(). */
01203    if ((errno = pthread_attr_setinheritsched(attr, PTHREAD_INHERIT_SCHED)))
01204       ast_log(LOG_WARNING, "pthread_attr_setinheritsched: %s\n", strerror(errno));
01205 #endif
01206 
01207    if (!stacksize)
01208       stacksize = AST_STACKSIZE;
01209 
01210    if ((errno = pthread_attr_setstacksize(attr, stacksize ? stacksize : AST_STACKSIZE)))
01211       ast_log(LOG_WARNING, "pthread_attr_setstacksize: %s\n", strerror(errno));
01212 
01213 #if !defined(LOW_MEMORY)
01214    if ((a = ast_malloc(sizeof(*a)))) {
01215       a->start_routine = start_routine;
01216       a->data = data;
01217       start_routine = dummy_start;
01218       if (ast_asprintf(&a->name, "%-20s started at [%5d] %s %s()",
01219               start_fn, line, file, caller) < 0) {
01220          a->name = NULL;
01221       }
01222       data = a;
01223    }
01224 #endif /* !LOW_MEMORY */
01225 
01226    return pthread_create(thread, attr, start_routine, data); /* We're in ast_pthread_create, so it's okay */
01227 }

long int ast_random ( void   ) 

Definition at line 1640 of file utils.c.

References ast_mutex_lock, ast_mutex_unlock, and randomlock.

Referenced by acf_rand_exec(), action_challenge(), add_sdp(), agent_new(), agi_handle_command(), ast_lock_path_lockfile(), ast_moh_files_next(), ast_rtp_change_source(), ast_rtp_new(), ast_udptl_new_with_bindaddr(), auth_http_callback(), authenticate_request(), build_gateway(), build_iv(), build_localtag_registry(), build_rand_pad(), build_reply_digest(), calc_metric(), calc_rxstamp(), caldav_write_event(), callno_hash(), create_channel_name(), generate_exchange_uuid(), generate_random_string(), generic_http_callback(), get_trans_id(), gtalk_alloc(), gtalk_create_candidates(), gtalk_new(), handle_incoming(), handle_response_invite(), iax2_key_rotate(), iax2_start_transfer(), jingle_alloc(), jingle_create_candidates(), jingle_new(), load_module(), make_email_file(), make_our_tag(), moh_files_alloc(), multicast_rtp_new(), 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().

01641 {
01642    long int res;
01643 #ifdef HAVE_DEV_URANDOM
01644    if (dev_urandom_fd >= 0) {
01645       int read_res = read(dev_urandom_fd, &res, sizeof(res));
01646       if (read_res > 0) {
01647          long int rm = RAND_MAX;
01648          res = res < 0 ? ~res : res;
01649          rm++;
01650          return res % rm;
01651       }
01652    }
01653 #endif
01654 #ifdef linux
01655    res = random();
01656 #else
01657    ast_mutex_lock(&randomlock);
01658    res = random();
01659    ast_mutex_unlock(&randomlock);
01660 #endif
01661    return res;
01662 }

void ast_register_thread ( char *  name  ) 

Definition at line 401 of file asterisk.c.

References ast_assert, ast_calloc, AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and multi_thread_safe.

Referenced by dummy_start().

00402 {
00403    struct thread_list_t *new = ast_calloc(1, sizeof(*new));
00404 
00405    if (!new)
00406       return;
00407 
00408    ast_assert(multi_thread_safe);
00409    new->id = pthread_self();
00410    new->name = name; /* steal the allocated memory for the thread name */
00411    AST_RWLIST_WRLOCK(&thread_list);
00412    AST_RWLIST_INSERT_HEAD(&thread_list, new, list);
00413    AST_RWLIST_UNLOCK(&thread_list);
00414 }

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 239 of file netsock.c.

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

Referenced by ast_readconfig().

00240 {
00241 #if defined(SIOCGIFHWADDR) && defined(HAVE_STRUCT_IFREQ_IFR_IFRU_IFRU_HWADDR)
00242    int s, x = 0;
00243    char eid_str[20];
00244    struct ifreq ifr;
00245    static const unsigned int MAXIF = 10;
00246 
00247    s = socket(AF_INET, SOCK_STREAM, 0);
00248    if (s < 0)
00249       return;
00250    for (x = 0; x < MAXIF; x++) {
00251       static const char *prefixes[] = { "eth", "em" };
00252       unsigned int i;
00253 
00254       for (i = 0; i < ARRAY_LEN(prefixes); i++) {
00255          memset(&ifr, 0, sizeof(ifr));
00256          snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "%s%d", prefixes[i], x);
00257          if (!ioctl(s, SIOCGIFHWADDR, &ifr)) {
00258             break;
00259          }
00260       }
00261 
00262       if (i == ARRAY_LEN(prefixes)) {
00263          /* Try pciX#[1..N] */
00264          for (i = 0; i < MAXIF; i++) {
00265             memset(&ifr, 0, sizeof(ifr));
00266             snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "pci%d#%u", x, i);
00267             if (!ioctl(s, SIOCGIFHWADDR, &ifr)) {
00268                break;
00269             }
00270          }
00271          if (i == MAXIF) {
00272             continue;
00273          }
00274       }
00275 
00276       memcpy(eid, ((unsigned char *)&ifr.ifr_hwaddr) + 2, sizeof(*eid));
00277       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);
00278       close(s);
00279       return;
00280    }
00281    close(s);
00282 #else
00283 #if defined(ifa_broadaddr) && !defined(SOLARIS)
00284    char eid_str[20];
00285    struct ifaddrs *ifap;
00286    
00287    if (getifaddrs(&ifap) == 0) {
00288       struct ifaddrs *p;
00289       for (p = ifap; p; p = p->ifa_next) {
00290          if ((p->ifa_addr->sa_family == AF_LINK) && !(p->ifa_flags & IFF_LOOPBACK) && (p->ifa_flags & IFF_RUNNING)) {
00291             struct sockaddr_dl* sdp = (struct sockaddr_dl*) p->ifa_addr;
00292             memcpy(&(eid->eid), sdp->sdl_data + sdp->sdl_nlen, 6);
00293             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);
00294             freeifaddrs(ifap);
00295             return;
00296          }
00297       }
00298       freeifaddrs(ifap);
00299    }
00300 #endif
00301 #endif
00302    ast_debug(1, "No ethernet interface found for seeding global EID. You will have to set it manually.\n");
00303 }

void ast_sha1_hash ( char *  output,
const char *  input 
)

Produces SHA1 hash based on input string.

Definition at line 261 of file utils.c.

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

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

00262 {
00263    struct SHA1Context sha;
00264    char *ptr;
00265    int x;
00266    uint8_t Message_Digest[20];
00267 
00268    SHA1Reset(&sha);
00269    
00270    SHA1Input(&sha, (const unsigned char *) input, strlen(input));
00271 
00272    SHA1Result(&sha, Message_Digest);
00273    ptr = output;
00274    for (x = 0; x < 20; x++)
00275       ptr += sprintf(ptr, "%2.2x", (unsigned)Message_Digest[x]);
00276 }

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

Definition at line 312 of file utils.h.

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

00313 {
00314    int res;
00315 
00316    res = (int) *input + *value;
00317    if (res > 32767)
00318       *input = 32767;
00319    else if (res < -32768)
00320       *input = -32768;
00321    else
00322       *input = (short) res;
00323 }

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

Definition at line 351 of file utils.h.

Referenced by ast_frame_adjust_volume(), and audiohook_read_frame_both().

00352 {
00353    *input /= *value;
00354 }

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

Definition at line 338 of file utils.h.

Referenced by ast_frame_adjust_volume(), and audiohook_read_frame_both().

00339 {
00340    int res;
00341 
00342    res = (int) *input * *value;
00343    if (res > 32767)
00344       *input = 32767;
00345    else if (res < -32768)
00346       *input = -32768;
00347    else
00348       *input = (short) res;
00349 }

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

Definition at line 325 of file utils.h.

Referenced by softmix_bridge_thread().

00326 {
00327    int res;
00328 
00329    res = (int) *input - *value;
00330    if (res > 32767)
00331       *input = 32767;
00332    else if (res < -32768)
00333       *input = -32768;
00334    else
00335       *input = (short) res;
00336 }

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 305 of file netsock.c.

References ast_eid::eid.

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

00306 {
00307    unsigned int eid_int[6];
00308    int x;
00309 
00310    if (sscanf(s, "%2x:%2x:%2x:%2x:%2x:%2x", &eid_int[0], &eid_int[1], &eid_int[2],
00311        &eid_int[3], &eid_int[4], &eid_int[5]) != 6)
00312          return -1;
00313    
00314    for (x = 0; x < 6; x++)
00315       eid->eid[x] = eid_int[x];
00316 
00317    return 0;
00318 }

void ast_unescape_quoted ( char *  quote_str  ) 

Unescape quotes in a string.

Parameters:
quote_str The string with quotes to be unescaped
Note:
This function mutates the passed-in string.

Definition at line 461 of file utils.c.

Referenced by ast_callerid_parse().

00462 {
00463    int esc_pos;
00464    int unesc_pos;
00465    int quote_str_len = strlen(quote_str);
00466 
00467    for (esc_pos = 0, unesc_pos = 0;
00468       esc_pos < quote_str_len;
00469       esc_pos++, unesc_pos++) {
00470       if (quote_str[esc_pos] == '\\') {
00471          /* at least one more char and current is \\ */
00472          esc_pos++;
00473          if (esc_pos >= quote_str_len) {
00474             break;
00475          }
00476       }
00477 
00478       quote_str[unesc_pos] = quote_str[esc_pos];
00479    }
00480    quote_str[unesc_pos] = '\0';
00481 }

void ast_unregister_thread ( void *  id  ) 

Definition at line 416 of file asterisk.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, thread_list_t::id, ast_atexit::list, and thread_list_t::name.

Referenced by dummy_start().

00417 {
00418    struct thread_list_t *x;
00419 
00420    AST_RWLIST_WRLOCK(&thread_list);
00421    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&thread_list, x, list) {
00422       if ((void *) x->id == id) {
00423          AST_RWLIST_REMOVE_CURRENT(list);
00424          break;
00425       }
00426    }
00427    AST_RWLIST_TRAVERSE_SAFE_END;
00428    AST_RWLIST_UNLOCK(&thread_list);
00429    if (x) {
00430       ast_free(x->name);
00431       ast_free(x);
00432    }
00433 }

void ast_uri_decode ( char *  s  ) 

Decode URI, URN, URL (overwrite string).

Parameters:
s String to be decoded

Definition at line 484 of file utils.c.

Referenced by acf_curl_helper(), config_curl(), get_destination(), get_name_and_number(), get_refer_info(), handle_request_invite(), http_decode(), parse_moved_contact(), realtime_curl(), realtime_multi_curl(), sip_new(), sip_uri_cmp(), and uridecode().

00485 {
00486    char *o;
00487    unsigned int tmp;
00488 
00489    for (o = s; *s; s++, o++) {
00490       if (*s == '%' && s[1] != '\0' && s[2] != '\0' && sscanf(s + 1, "%2x", &tmp) == 1) {
00491          /* have '%', two chars and correct parsing */
00492          *o = tmp;
00493          s += 2;  /* Will be incremented once more when we break out */
00494       } else /* all other cases, just copy */
00495          *o = *s;
00496    }
00497    *o = '\0';
00498 }

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

Turn text string to URI-encoded XX version.

Note:
At this point, this function is encoding agnostic; it does not check whether it is fed legal UTF-8. We escape control characters (-), '', and all characters above 0x7F. If do_special_char == 1 we will convert all characters except alnum and the mark set. 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
do_special_char Convert all non alphanum characters execept those in the mark set as defined by rfc 3261 section 25.1
Note:
At this point, this function is encoding agnostic; it does not check whether it is fed legal UTF-8. We escape control characters (-), '', and all characters above 0x7F. If do_special_char == 1 we will convert all characters except alnum and mark. 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.

Definition at line 398 of file utils.c.

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

00399 {
00400    const char *ptr  = string; /* Start with the string */
00401    char *out = outbuf;
00402    const char *mark = "-_.!~*'()"; /* no encode set, RFC 2396 section 2.3, RFC 3261 sec 25 */
00403 
00404    while (*ptr && out - outbuf < buflen - 1) {
00405       if ((const signed char) *ptr < 32 || *ptr == 0x7f || *ptr == '%' ||
00406             (do_special_char &&
00407             !(*ptr >= '0' && *ptr <= '9') &&      /* num */
00408             !(*ptr >= 'A' && *ptr <= 'Z') &&      /* ALPHA */
00409             !(*ptr >= 'a' && *ptr <= 'z') &&      /* alpha */
00410             !strchr(mark, *ptr))) {               /* mark set */
00411          if (out - outbuf >= buflen - 3) {
00412             break;
00413          }
00414 
00415          out += sprintf(out, "%%%02X", (unsigned) *ptr);
00416       } else {
00417          *out = *ptr;   /* Continue copying the string */
00418          out++;
00419       }
00420       ptr++;
00421    }
00422 
00423    if (buflen) {
00424       *out = '\0';
00425    }
00426 
00427    return outbuf;
00428 }

int ast_utils_init ( void   ) 

Definition at line 2193 of file utils.c.

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

Referenced by main().

02194 {
02195 #ifdef HAVE_DEV_URANDOM
02196    dev_urandom_fd = open("/dev/urandom", O_RDONLY);
02197 #endif
02198    base64_init();
02199 #ifdef DEBUG_THREADS
02200 #if !defined(LOW_MEMORY)
02201    ast_cli_register_multiple(utils_cli, ARRAY_LEN(utils_cli));
02202    ast_register_atexit(utils_shutdown);
02203 #endif
02204 #endif
02205    return 0;
02206 }

char* ast_utils_which ( const char *  binary,
char *  fullpath,
size_t  fullpath_size 
)

Resolve a binary to a full pathname.

Parameters:
binary Name of the executable to resolve
fullpath Buffer to hold the complete pathname
fullpath_size Size of fullpath
Return values:
NULL binary was not found or the environment variable PATH is not set
Returns:
fullpath

Definition at line 2364 of file utils.c.

References ast_strdupa.

Referenced by ast_bt_get_symbols().

02365 {
02366    const char *envPATH = getenv("PATH");
02367    char *tpath, *path;
02368    struct stat unused;
02369    if (!envPATH) {
02370       return NULL;
02371    }
02372    tpath = ast_strdupa(envPATH);
02373    while ((path = strsep(&tpath, ":"))) {
02374       snprintf(fullpath, fullpath_size, "%s/%s", path, binary);
02375       if (!stat(fullpath, &unused)) {
02376          return fullpath;
02377       }
02378    }
02379    return NULL;
02380 }

int ast_wait_for_input ( int  fd,
int  ms 
)

Definition at line 1255 of file utils.c.

References ast_poll.

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

01256 {
01257    struct pollfd pfd[1];
01258 
01259    memset(pfd, 0, sizeof(pfd));
01260    pfd[0].fd = fd;
01261    pfd[0].events = POLLIN | POLLPRI;
01262    return ast_poll(pfd, 1, ms);
01263 }

int ast_wait_for_output ( int  fd,
int  ms 
)

Definition at line 1265 of file utils.c.

References ast_poll.

Referenced by tcptls_stream_read(), and tcptls_stream_write().

01266 {
01267    struct pollfd pfd[1];
01268 
01269    memset(pfd, 0, sizeof(pfd));
01270    pfd[0].fd = fd;
01271    pfd[0].events = POLLOUT;
01272    return ast_poll(pfd, 1, ms);
01273 }

int ast_xml_escape ( const char *  string,
char *  outbuf,
size_t  buflen 
)

Escape reserved characters for use in XML.

ast_xml_escape If outbuf is too short, the output string will be truncated. Regardless, the output will always be null terminated.

Parameters:
string String to be converted
outbuf Resulting encoded string
buflen Size of output buffer
Returns:
0 for success
-1 if buflen is too short.

Definition at line 500 of file utils.c.

References ast_assert, entity, and len().

Referenced by state_notify_build_xml().

00501 {
00502    char *dst = outbuf;
00503    char *end = outbuf + buflen - 1; /* save one for the null terminator */
00504 
00505    /* Handle the case for the empty output buffer */
00506    if (buflen == 0) {
00507       return -1;
00508    }
00509 
00510    /* Escaping rules from http://www.w3.org/TR/REC-xml/#syntax */
00511    /* This also prevents partial entities at the end of a string */
00512    while (*string && dst < end) {
00513       const char *entity = NULL;
00514       int len = 0;
00515 
00516       switch (*string) {
00517       case '<':
00518          entity = "&lt;";
00519          len = 4;
00520          break;
00521       case '&':
00522          entity = "&amp;";
00523          len = 5;
00524          break;
00525       case '>':
00526          /* necessary if ]]> is in the string; easier to escape them all */
00527          entity = "&gt;";
00528          len = 4;
00529          break;
00530       case '\'':
00531          /* necessary in single-quoted strings; easier to escape them all */
00532          entity = "&apos;";
00533          len = 6;
00534          break;
00535       case '"':
00536          /* necessary in double-quoted strings; easier to escape them all */
00537          entity = "&quot;";
00538          len = 6;
00539          break;
00540       default:
00541          *dst++ = *string++;
00542          break;
00543       }
00544 
00545       if (entity) {
00546          ast_assert(len == strlen(entity));
00547          if (end - dst < len) {
00548             /* no room for the entity; stop */
00549             break;
00550          }
00551          /* just checked for length; strcpy is fine */
00552          strcpy(dst, entity);
00553          dst += len;
00554          ++string;
00555       }
00556    }
00557    /* Write null terminator */
00558    *dst = '\0';
00559    /* If any chars are left in string, return failure */
00560    return *string == '\0' ? 0 : -1;
00561 }


Variable Documentation

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.
 

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

Referenced by aji_devstate_cb(), aji_handle_pubsub_event(), aji_mwi_cb(), aji_publish_device_state(), aji_publish_mwi(), ast_event_append_eid(), ast_event_cb(), ast_readconfig(), ast_str_retrieve_variable(), evt_event_deliver_cb(), handle_show_settings(), and set_config().


Generated on 31 Aug 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1