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"

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

struct ast_http_digest

Defines

#define ARRAY_LEN(a)   (sizeof(a) / sizeof(0[a]))

#define ast_asprintf(ret, fmt,...)   _ast_asprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, fmt, __VA_ARGS__)

A wrapper for asprintf().

#define ast_assert(a)

#define AST_BACKGROUND_STACKSIZE   AST_STACKSIZE

#define ast_calloc(num, len)   _ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for calloc().

#define ast_calloc_cache(num, len)   _ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for calloc() for use in cache pools.

#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_free   free

free() wrapper

#define ast_free_ptr   ast_free

#define ast_malloc(len)   _ast_malloc((len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for malloc().

#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_realloc(p, len)   _ast_realloc((p), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for realloc().

#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_strdup(str)   _ast_strdup((str), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for strdup().

#define ast_strdupa(s)

duplicate a string in memory from the stack

#define ast_strndup(str, len)   _ast_strndup((str), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for strndup().

#define ast_test_flag(p, flag)

#define ast_test_flag64(p, flag)

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

#define ast_vasprintf(ret, fmt, ap)   _ast_vasprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, (fmt), (ap))

A wrapper for vasprintf().

#define localtime_r   __dont_use_localtime_r_use_ast_localtime_instead__

#define MALLOC_FAILURE_MSG   ast_log(LOG_ERROR, "Memory Allocation Failure in function %s at line %d of %s\n", func, lineno, file);

#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_asprintf (char **ret, const char *file, int lineno, const char *func, const char *fmt,...)

void *attribute_malloc _ast_calloc (size_t num, size_t len, const char *file, int lineno, const char *func)

void *attribute_malloc _ast_malloc (size_t len, const char *file, int lineno, const char *func)

void *attribute_malloc _ast_realloc (void *p, size_t len, const char *file, int lineno, const char *func)

char *attribute_malloc _ast_strdup (const char *str, const char *file, int lineno, const char *func)

char *attribute_malloc _ast_strndup (const char *str, size_t len, const char *file, int lineno, const char *func)

int _ast_vasprintf (char **ret, const char *file, int lineno, const char *func, const char *fmt, va_list ap)

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.

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_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 654 of file utils.h.

#define ast_asprintf	(	ret,
		fmt,
		...	)	_ast_asprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, fmt, __VA_ARGS__)

A wrapper for asprintf().

ast_asprintf() is a wrapper for asprintf() that will generate an Asterisk log message in the case that the allocation fails.

The arguments and return value are the same as asprintf()

Definition at line 578 of file utils.h.

#define ast_assert ( a )

Definition at line 707 of file utils.h.

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

#define AST_BACKGROUND_STACKSIZE AST_STACKSIZE

Definition at line 364 of file utils.h.

#define ast_calloc	(	num,
		len		)	_ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for calloc().

ast_calloc() is a wrapper for calloc() that will generate an Asterisk log message in the case that the allocation fails.

The arguments and return value are the same as calloc()

Definition at line 461 of file utils.h.

#define ast_calloc_cache	(	num,
		len		)	_ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for calloc() for use in cache pools.

ast_calloc_cache() is a wrapper for calloc() that will generate an Asterisk log message in the case that the allocation fails. When memory debugging is in use, the memory allocated by this function will be marked as 'cache' so it can be distinguished from normal memory allocations.

The arguments and return value are the same as calloc()

Definition at line 486 of file utils.h.

#define ast_clear_flag	(	p,
		flag		)

Definition at line 77 of file utils.h.

Referenced by __ast_pbx_run(), __ast_read(), __do_deliver(), __transmit_response(), 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_generic_bridge(), ast_jb_destroy(), ast_jb_put(), ast_rtp_raw_write(), ast_sendtext(), ast_speech_start(), ast_tls_read_conf(), ast_waitfor_nandfds(), ast_waitfordigit_full(), ast_write(), bridge_channel_feature(), bridge_p2p_rtp_write(), builtin_atxfer(), 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(), dictate_exec(), disa_exec(), dundi_lookup_local(), extenspy_exec(), find_conf(), find_conf_realtime(), forward_message(), handle_command_response(), handle_common_options(), handle_request_bye(), handle_request_invite(), handle_request_refer(), handle_response(), handle_response_notify(), handle_speechrecognize(), handle_t38_options(), handle_verbose(), 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(), park_call_full(), parkandannounce_exec(), phone_read(), playtones_alloc(), process_sdp(), register_verify(), reload_config(), reset_transaction(), set_config(), 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 134 of file utils.h.

Referenced by authenticate_verify(), build_peer(), build_user(), create_addr(), do_forward(), iax2_destroy_helper(), set_config(), set_config_destroy(), socket_process(), and wait_for_answer().

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

Definition at line 141 of file utils.h.

Referenced by __find_callno(), build_peer(), build_user(), check_access(), create_addr(), dial_exec_full(), iax2_request(), realtime_peer(), 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 184 of file utils.h.

#define AST_FLAGS_ALL UINT_MAX

#define ast_free free

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 422 of file utils.h.

#define ast_free_ptr ast_free

Definition at line 423 of file utils.h.

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

#define ast_malloc ( len ) _ast_malloc((len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for malloc().

ast_malloc() is a wrapper for malloc() that will generate an Asterisk log message in the case that the allocation fails.

The argument and return value are the same as malloc()

Definition at line 438 of file utils.h.

#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 378 of file utils.h.

Referenced by __analog_handle_event(), accept_thread(), ast_bridge_impart(), ast_dial_run(), ast_features_init(), ast_taskprocessor_get(), bridge_call_thread_launch(), bridge_channel_join(), build_calendar(), 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(), multiplexed_add_or_remove(), 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 386 of file utils.h.

Referenced by add_notify(), aji_reload(), ast_autoservice_start(), ast_device_state_engine_init(), ast_enable_distributed_devstate(), ast_makesocket(), ast_sched_thread_create(), ast_tcptls_server_start(), calendar_event_notify(), conf_run(), config_load(), do_monitor(), do_reload(), init_app_class(), init_timing_thread(), load_module(), local_ast_moh_start(), restart_monitor(), sip_prepare_socket(), smdi_load(), start_network_thread(), 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 382 of file utils.h.

Referenced by action_originate(), analog_handle_init_event(), analog_ss_thread_start(), ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_pbx_start(), dahdi_handle_event(), do_monitor(), dundi_answer_entity(), dundi_answer_query(), dundi_prop_precache(), handle_hd_hf(), handle_init_event(), launch_service(), main(), mwi_thread(), 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 391 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_realloc	(	p,
		len		)	_ast_realloc((p), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for realloc().

ast_realloc() is a wrapper for realloc() that will generate an Asterisk log message in the case that the allocation fails.

The arguments and return value are the same as realloc()

Definition at line 497 of file utils.h.

#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 __ast_pbx_run(), __ast_read(), __ast_request_and_dial(), __sip_subscribe_mwi_do(), _macro_exec(), action_redirect(), aji_load_config(), app_exec(), apply_peer(), ast_app_parse_options(), 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_generic_bridge(), ast_hangup(), ast_jb_do_usecheck(), ast_jb_put(), ast_rtp_local_bridge(), ast_rtp_new_source(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_stop(), ast_speech_change_state(), ast_tls_read_conf(), ast_waitfor_nandfds(), ast_waitfordigit_full(), asyncgoto_exec(), bridge_channel_feature(), bridge_exec(), bridge_p2p_rtp_write(), builtin_atxfer(), builtin_blindtransfer(), cb_extensionstate(), change_spy_mode(), channel_spy(), chanspy_exec(), check_availability(), check_bridge(), check_peer_ok(), check_user_full(), check_via(), common_exec(), connect_link(), create_addr_from_peer(), create_transaction(), dahdi_read(), dahdiscan_exec(), destroy_trans(), dial_exec_full(), dial_trunk(), 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(), handle_command_response(), handle_common_options(), 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(), 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_queue_reload(), manager_sipnotify(), minivm_greet_exec(), nocdr_exec(), odbc_load_module(), park_call_full(), park_exec_full(), playtones_alloc(), post_cdr(), process_cn_rfc3389(), process_sdp(), qualify_peer(), record_exec(), register_verify(), reload_config(), ring_entry(), rpt(), rpt_call(), rpt_exec(), rpt_tele_thread(), run_station(), set_bridge_features_on_config(), set_config_flags(), set_insecure_flags(), sip_answer(), sip_call(), sip_cli_notify(), sip_dtmfmode(), sip_hangup(), sip_indicate(), sip_poke_peer(), sip_read(), 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(), update_connectedline(), vm_execmain(), volume_write(), and waitstream_core().

#define ast_set_flag64	(	p,
		flag		)

Definition at line 127 of file utils.h.

Referenced by ast_app_parse_options64(), authenticate_reply(), authenticate_request(), build_peer(), build_user(), check_access(), decrypt_frame(), dial_exec_full(), handle_cli_iax2_prune_realtime(), iax2_predestroy(), iax2_provision(), iax2_start_transfer(), peer_delme_cb(), pvt_destructor(), realtime_peer(), realtime_user(), set_config(), socket_process(), and user_delme_cb().

#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 359 of file utils.h.

Referenced by ast_pthread_create_stack().

#define ast_strdup ( str ) _ast_strdup((str), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for strdup().

ast_strdup() is a wrapper for strdup() that will generate an Asterisk log message in the case that the allocation fails.

ast_strdup(), unlike strdup(), can safely accept a NULL argument. If a NULL argument is provided, ast_strdup will return NULL without generating any kind of error log message.

The argument and return value are the same as strdup()

Definition at line 524 of file utils.h.

#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 618 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_jabberreceive_read(), acf_meetme_info(), acf_odbc_write(), action_agents(), action_status(), add_agent(), add_peer_mailboxes(), add_redirect(), add_var(), admin_exec(), advanced_options(), agi_exec_full(), 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(), array_remove(), ast_aji_get_client(), ast_app_getdata(), ast_append_ha(), 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_set_linkgroup(), ast_eivr_setvariable(), ast_el_add_history(), ast_filehelper(), ast_func_read(), ast_func_read2(), ast_func_write(), ast_get_group(), ast_http_get_cookies(), ast_mkdir(), ast_monitor_change_fname(), ast_monitor_start(), ast_netsock_bind(), ast_parse_allow_disallow(), ast_parse_arg(), ast_pickup_call(), ast_playtones_start(), ast_register_file_version(), ast_str_retrieve_variable(), ast_writefile(), astman_get_variables(), 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_user(), builtin_atxfer(), builtin_automixmonitor(), builtin_automonitor(), cache_get_callno_locked(), callerid_write(), celgenuserevent_exec(), chanavail_exec(), 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(), conf_exec(), conf_run(), conf_start_moh(), confbridge_exec(), config_function_read(), config_line(), config_module(), connectedline_write(), controlplayback_exec(), count_exec(), create_addr(), create_addr_from_peer(), create_followme_number(), create_vmaccount(), cut_internal(), dahdi_request(), dahdiras_exec(), dahdiscan_exec(), decrypt_frame(), del_exec(), deltree_exec(), dial_exec_full(), dial_trunk(), dialgroup_refreshdb(), dialgroup_write(), dictate_exec(), directory_exec(), disa_exec(), do_forward(), do_immediate_setup(), do_message(), do_notify(), do_say(), dundi_query_read(), dundi_result_read(), dundifunc_read(), enum_query_read(), enum_result_read(), exec_exec(), execif_exec(), extenspy_exec(), feature_interpret(), festival_exec(), fileexists_core(), find_conf(), find_conf_realtime(), find_gtalk(), find_sdp(), find_table(), find_table_cb(), findmeexec(), forkcdr_exec(), function_agent(), function_iaxpeer(), function_realtime_store(), get_cid_name(), 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_check_permissions(), handle_cli_dialplan_add_extension(), handle_cli_file_convert(), handle_cli_udptl_set_debug(), handle_debug_dialplan(), handle_mgcp_audit_endpoint(), handle_options(), handle_request_invite(), handle_request_notify(), handle_request_subscribe(), handle_response(), handle_show_dialplan(), handle_t38_options(), 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_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_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(), orig_app(), orig_exten(), originate_exec(), ospauth_exec(), ospfinished_exec(), osplookup_exec(), ospnext_exec(), oss_call(), oss_request(), page_exec(), park_call_exec(), parkandannounce_exec(), parse_allowed_methods(), parse_apps(), parse_empty_options(), parse_events(), parse_session_expires(), parse_sip_options(), parse_uri(), 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_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_dahdi(), process_echocancel(), process_sdp(), 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(), redirecting_id_write(), 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(), sayunixtime_exec(), senddtmf_exec(), sendmail(), sendtext_exec(), sendurl_exec(), set_config_flags(), setup_privacy_args(), sip_devicestate(), sip_do_debug_ip(), sip_new(), 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(), start_moh_exec(), start_monitor_action(), start_monitor_exec(), state_notify_build_xml(), timezone_add(), transfer_exec(), transmit_invite(), transmit_refer(), try_calling(), try_suggested_sip_codec(), 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_answer(), wait_for_winner(), waitstream_core(), and zapateller_exec().

#define ast_strndup	(	str,
		len		)	_ast_strndup((str), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)

A wrapper for strndup().

ast_strndup() is a wrapper for strndup() that will generate an Asterisk log message in the case that the allocation fails.

ast_strndup(), unlike strndup(), can safely accept a NULL argument for the string to duplicate. If a NULL argument is provided, ast_strdup will return NULL without generating any kind of error log message.

The arguments and return value are the same as strndup()

Definition at line 553 of file utils.h.

#define ast_test_flag	(	p,
		flag		)

Definition at line 63 of file utils.h.

Referenced by __ast_pbx_run(), __ast_queue_frame(), __ast_read(), __sip_destroy(), __ssl_setup(), __transmit_response(), _macro_exec(), _sip_show_peer(), _sip_show_peers(), acf_odbc_read(), add_agent(), add_codec_to_sdp(), add_rpid(), add_sdp(), aji_pruneregister(), app_exec(), ast_audiohook_write_frame(), ast_autoservice_start(), ast_bridge_call(), ast_bridge_merge(), 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_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_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_moh_files_next(), ast_odbc_request_obj2(), ast_quiet_chan(), ast_raw_answer(), ast_readstring_full(), ast_rtp_raw_write(), ast_sendtext(), ast_softhangup_nolock(), ast_streamfile(), 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(), callback_dialoptions(), cb_extensionstate(), cdr_read(), cdr_write(), change_t38_state(), 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(), conf_exec(), confbridge_exec(), config_text_file_load(), 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(), 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(), execute_cb(), expire_register(), extenspy_exec(), feature_exec_app(), feature_interpret_helper(), find_cache(), find_call(), find_conf(), find_conf_realtime(), find_or_create(), find_user(), find_user_realtime(), forkcdr_exec(), forward_message(), free_user(), get_destination(), get_insecure_variable_from_config(), get_rpid(), gosub_exec(), handle_cli_moh_show_classes(), handle_command_response(), 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_write(), initreqprep(), interpret_t38_parameters(), join_conference_bridge(), leave_conference_bridge(), leave_voicemail(), load_resource(), local_alloc(), local_ast_moh_start(), local_bridgedchannel(), local_call(), local_hangup(), local_queue_frame(), local_write(), main(), make_email_file(), manager_list_voicemail_users(), 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(), notify_new_message(), page_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_sdp(), process_text_line(), read_exec(), readexten_exec(), realtime_peer(), realtime_switch_common(), record_exec(), register_verify(), reload_config(), reload_handler(), reload_queues(), reload_single_queue(), remove_from_queue(), reqprep(), respprep(), retrydial_exec(), rpt_master(), search_directory_sub(), select_entry(), send_request(), 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_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_response_with_sdp(), try_calling(), update_call_counter(), update_connectedline(), update_peer(), update_redirecting(), 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 120 of file utils.h.

Referenced by __do_deliver(), __expire_registry(), __get_from_jb(), __iax2_show_peers(), ast_app_options2str64(), ast_cli_netstats(), authenticate_reply(), authenticate_request(), authenticate_verify(), build_peer(), build_user(), check_access(), complete_iax2_peers(), decrypt_frame(), dial_exec_full(), do_forward(), function_iaxpeer(), handle_cli_iax2_prune_realtime(), handle_cli_iax2_show_channels(), handle_cli_iax2_show_peer(), handle_cli_iax2_show_users(), iax2_bridge(), iax2_call(), iax2_destroy_helper(), iax2_getpeertrunk(), iax2_hangup(), iax2_indicate(), iax2_predestroy(), iax2_request(), iax2_send(), iax2_trunk_queue(), iax2_write(), log_jitterstats(), manager_iax2_show_peer_list(), prune_peers(), prune_users(), realtime_peer(), realtime_update_peer(), realtime_user(), reg_source_db(), register_verify(), retrydial_exec(), schedule_delivery(), send_trunk(), set_config(), setup_privacy_args(), socket_process(), update_registry(), valid_priv_reply(), and wait_for_answer().

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

Definition at line 173 of file utils.h.

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

#define ast_vasprintf	(	ret,
		fmt,
		ap	)	_ast_vasprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, (fmt), (ap))

A wrapper for vasprintf().

ast_vasprintf() is a wrapper for vasprintf() that will generate an Asterisk log message in the case that the allocation fails.

The arguments and return value are the same as vasprintf()

Definition at line 592 of file utils.h.

#define localtime_r __dont_use_localtime_r_use_ast_localtime_instead__

Definition at line 320 of file utils.h.

#define MALLOC_FAILURE_MSG ast_log(LOG_ERROR, "Memory Allocation Failure in function %s at line %d of %s\n", func, lineno, file);

Definition at line 428 of file utils.h.

Referenced by _ast_asprintf().

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

Definition at line 228 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 226 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_asprintf	(	char **	ret,
		const char *	file,
		int	lineno,
		const char *	func,
		const char *	fmt,
			...
	)

Definition at line 2045 of file utils.c.

References MALLOC_FAILURE_MSG, and vasprintf.

02046 {
02047    int res;
02048    va_list ap;
02049 
02050    va_start(ap, fmt);
02051    if ((res = vasprintf(ret, fmt, ap)) == -1) {
02052       MALLOC_FAILURE_MSG;
02053    }
02054    va_end(ap);
02055 
02056    return res;
02057 }

void *attribute_malloc _ast_calloc	(	size_t	num,
		size_t	len,
		const char *	file,
		int	lineno,
		const char *	func
	)			`[inline]`

Definition at line 474 of file utils.h.

00502 {

void *attribute_malloc _ast_malloc	(	size_t	len,
		const char *	file,
		int	lineno,
		const char *	func
	)			`[inline]`

Definition at line 451 of file utils.h.

00466 {

void *attribute_malloc _ast_realloc	(	void *	p,
		size_t	len,
		const char *	file,
		int	lineno,
		const char *	func
	)			`[inline]`

Definition at line 510 of file utils.h.

00529 {

char *attribute_malloc _ast_strdup	(	const char *	str,
		const char *	file,
		int	lineno,
		const char *	func
	)			`[inline]`

Definition at line 539 of file utils.h.

00558 {

char *attribute_malloc _ast_strndup	(	const char *	str,
		size_t	len,
		const char *	file,
		int	lineno,
		const char *	func
	)			`[inline]`

Definition at line 568 of file utils.h.

00598 {

int _ast_vasprintf	(	char **	ret,
		const char *	file,
		int	lineno,
		const char *	func,
		const char *	fmt,
		va_list	ap
	)			`[inline]`

Definition at line 606 of file utils.h.

00620 {                                                                \

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(), aes_helper(), base64_helper(), and osp_validate_token().

00265 {
00266    int cnt = 0;
00267    unsigned int byte = 0;
00268    unsigned int bits = 0;
00269    int incnt = 0;
00270    while (*src && (cnt < max)) {
00271       /* Shift in 6 bits of input */
00272       byte <<= 6;
00273       byte |= (b2a[(int)(*src)]) & 0x3f;
00274       bits += 6;
00275       src++;
00276       incnt++;
00277       /* If we have at least 8 bits left over, take that character 
00278          off the top */
00279       if (bits >= 8)  {
00280          bits -= 8;
00281          *dst = (byte >> bits) & 0xff;
00282          dst++;
00283          cnt++;
00284       }
00285    }
00286    /* Dont worry about left over bits, they're extra anyway */
00287    return cnt;
00288 }

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(), aes_helper(), aji_start_sasl(), base64_helper(), build_secret(), and osp_check_destination().

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

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

00292 {
00293    int cnt = 0;
00294    int col = 0;
00295    unsigned int byte = 0;
00296    int bits = 0;
00297    int cntin = 0;
00298    /* Reserve space for null byte at end of string */
00299    max--;
00300    while ((cntin < srclen) && (cnt < max)) {
00301       byte <<= 8;
00302       byte |= *(src++);
00303       bits += 8;
00304       cntin++;
00305       if ((bits == 24) && (cnt + 4 <= max)) {
00306          *dst++ = base64[(byte >> 18) & 0x3f];
00307          *dst++ = base64[(byte >> 12) & 0x3f];
00308          *dst++ = base64[(byte >> 6) & 0x3f];
00309          *dst++ = base64[byte & 0x3f];
00310          cnt += 4;
00311          col += 4;
00312          bits = 0;
00313          byte = 0;
00314       }
00315       if (linebreaks && (cnt < max) && (col == 64)) {
00316          *dst++ = '\n';
00317          cnt++;
00318          col = 0;
00319       }
00320    }
00321    if (bits && (cnt + 4 <= max)) {
00322       /* Add one last character for the remaining bits, 
00323          padding the rest with 0 */
00324       byte <<= 24 - bits;
00325       *dst++ = base64[(byte >> 18) & 0x3f];
00326       *dst++ = base64[(byte >> 12) & 0x3f];
00327       if (bits == 16)
00328          *dst++ = base64[(byte >> 6) & 0x3f];
00329       else
00330          *dst++ = '=';
00331       *dst++ = '=';
00332       cnt += 4;
00333    }
00334    if (linebreaks && (cnt < max)) {
00335       *dst++ = '\n';
00336       cnt++;
00337    }
00338    *dst = '\0';
00339    return cnt;
00340 }

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

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

Referenced by send_string().

01153 {
01154    struct timeval start = ast_tvnow();
01155    int n = 0;
01156    int elapsed = 0;
01157 
01158    while (len) {
01159       if (ast_wait_for_output(fd, timeoutms - elapsed)) {
01160          /* poll returned a fatal error, so bail out immediately. */
01161          return -1;
01162       }
01163 
01164       /* Clear any errors from a previous write */
01165       clearerr(f);
01166 
01167       n = fwrite(src, 1, len, f);
01168 
01169       if (ferror(f) && errno != EINTR && errno != EAGAIN) {
01170          /* fatal error from fwrite() */
01171          if (!feof(f)) {
01172             /* Don't spam the logs if it was just that the connection is closed. */
01173             ast_log(LOG_ERROR, "fwrite() returned error: %s\n", strerror(errno));
01174          }
01175          n = -1;
01176          break;
01177       }
01178 
01179       /* Update for data already written to the socket */
01180       len -= n;
01181       src += n;
01182 
01183       elapsed = ast_tvdiff_ms(ast_tvnow(), start);
01184       if (elapsed >= timeoutms) {
01185          /* We've taken too long to write 
01186           * This is only an error condition if we haven't finished writing. */
01187          n = len ? -1 : 0;
01188          break;
01189       }
01190    }
01191 
01192    while (fflush(f)) {
01193       if (errno == EAGAIN || errno == EINTR) {
01194          continue;
01195       }
01196       if (!feof(f)) {
01197          /* Don't spam the logs if it was just that the connection is closed. */
01198          ast_log(LOG_ERROR, "fflush() returned error: %s\n", strerror(errno));
01199       }
01200       n = -1;
01201       break;
01202    }
01203 
01204    return n < 0 ? -1 : 0;
01205 }

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

01112 {
01113    struct timeval start = ast_tvnow();
01114    int res = 0;
01115    int elapsed = 0;
01116 
01117    while (len) {
01118       if (ast_wait_for_output(fd, timeoutms - elapsed)) {
01119          return -1;
01120       }
01121 
01122       res = write(fd, s, len);
01123 
01124       if (res < 0 && errno != EAGAIN && errno != EINTR) {
01125          /* fatal error from write() */
01126          ast_log(LOG_ERROR, "write() returned error: %s\n", strerror(errno));
01127          return -1;
01128       }
01129 
01130       if (res < 0) {
01131          /* It was an acceptable error */
01132          res = 0;
01133       }
01134 
01135       /* Update how much data we have left to write */
01136       len -= res;
01137       s += res;
01138       res = 0;
01139 
01140       elapsed = ast_tvdiff_ms(ast_tvnow(), start);
01141       if (elapsed >= timeoutms) {
01142          /* We've taken too long to write 
01143           * This is only an error condition if we haven't finished writing. */
01144          res = len ? -1 : 0;
01145          break;
01146       }
01147    }
01148 
01149    return res;
01150 }

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 ast_event_cb(), 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(), evt_event_deliver_cb(), find_peer(), handle_command_response(), optimize_transactions(), and register_request().

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

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

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

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

References ast_log(), and LOG_WARNING.

Referenced by ast_netsock_bindaddr(), and reload_config().

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

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(), __set_address_from_contact(), app_exec(), ast_find_ourip(), ast_get_ip_or_srv(), ast_parse_arg(), build_peer(), config_load(), config_parse_variables(), create_addr(), festival_exec(), get_ip_and_port_from_sdp(), gtalk_load_config(), gtalk_update_stun(), handle_cli_udptl_set_debug(), iax_template_parse(), jingle_load_config(), jingle_update_stun(), launch_netscript(), parse_register_contact(), process_sdp(), 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().

00183 {
00184    int res;
00185    int herrno;
00186    int dots = 0;
00187    const char *s;
00188    struct hostent *result = NULL;
00189    /* Although it is perfectly legitimate to lookup a pure integer, for
00190       the sake of the sanity of people who like to name their peers as
00191       integers, we break with tradition and refuse to look up a
00192       pure integer */
00193    s = host;
00194    res = 0;
00195    while (s && *s) {
00196       if (*s == '.')
00197          dots++;
00198       else if (!isdigit(*s))
00199          break;
00200       s++;
00201    }
00202    if (!s || !*s) {
00203       /* Forge a reply for IP's to avoid octal IP's being interpreted as octal */
00204       if (dots != 3)
00205          return NULL;
00206       memset(hp, 0, sizeof(struct ast_hostent));
00207       hp->hp.h_addrtype = AF_INET;
00208       hp->hp.h_addr_list = (void *) hp->buf;
00209       hp->hp.h_addr = hp->buf + sizeof(void *);
00210       if (inet_pton(AF_INET, host, hp->hp.h_addr) > 0)
00211          return &hp->hp;
00212       return NULL;
00213       
00214    }
00215 #ifdef HAVE_GETHOSTBYNAME_R_5
00216    result = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &herrno);
00217 
00218    if (!result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
00219       return NULL;
00220 #else
00221    res = gethostbyname_r(host, &hp->hp, hp->buf, sizeof(hp->buf), &result, &herrno);
00222 
00223    if (res || !result || !hp->hp.h_addr_list || !hp->hp.h_addr_list[0])
00224       return NULL;
00225 #endif
00226    return &hp->hp;
00227 }

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

Produces MD5 hash based on input string.

Definition at line 230 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().

00231 {
00232    struct MD5Context md5;
00233    unsigned char digest[16];
00234    char *ptr;
00235    int x;
00236 
00237    MD5Init(&md5);
00238    MD5Update(&md5, (const unsigned char *) input, strlen(input));
00239    MD5Final(digest, &md5);
00240    ptr = output;
00241    for (x = 0; x < 16; x++)
00242       ptr += sprintf(ptr, "%2.2x", digest[x]);
00243 }

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

01876 {
01877    char *ptr;
01878    int len = strlen(path), count = 0, x, piececount = 0;
01879    char *tmp = ast_strdupa(path);
01880    char **pieces;
01881    char *fullpath = alloca(len + 1);
01882    int res = 0;
01883 
01884    for (ptr = tmp; *ptr; ptr++) {
01885       if (*ptr == '/')
01886          count++;
01887    }
01888 
01889    /* Count the components to the directory path */
01890    pieces = alloca(count * sizeof(*pieces));
01891    for (ptr = tmp; *ptr; ptr++) {
01892       if (*ptr == '/') {
01893          *ptr = '\0';
01894          pieces[piececount++] = ptr + 1;
01895       }
01896    }
01897 
01898    *fullpath = '\0';
01899    for (x = 0; x < piececount; x++) {
01900       /* This looks funky, but the buffer is always ideally-sized, so it's fine. */
01901       strcat(fullpath, "/");
01902       strcat(fullpath, pieces[x]);
01903       res = mkdir(fullpath, mode);
01904       if (res && errno != EEXIST)
01905          return errno;
01906    }
01907    return 0;
01908 }

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.

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

References ast_free, ast_log(), ast_skip_blanks(), ast_str_buffer(), ast_str_create(), ast_str_set(), ast_string_field_set, ast_strlen_zero(), ast_http_digest::cnonce, LOG_WARNING, ast_http_digest::nc, ast_http_digest::nonce, 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().

01932                                                                                                {
01933    int i;
01934    char *c, key[512], val[512], tmp[512];
01935    struct ast_str *str = ast_str_create(16);
01936 
01937    if (ast_strlen_zero(digest) || !d || !str) {
01938       ast_free(str);
01939       return -1;
01940    }
01941 
01942    ast_str_set(&str, 0, "%s", digest);
01943 
01944    c = ast_skip_blanks(ast_str_buffer(str));
01945 
01946    if (strncasecmp(tmp, "Digest ", strlen("Digest "))) {
01947       ast_log(LOG_WARNING, "Missing Digest.\n");
01948       ast_free(str);
01949       return -1;
01950    }
01951    c += strlen("Digest ");
01952 
01953    /* lookup for keys/value pair */
01954    while (*c && *(c = ast_skip_blanks(c))) {
01955       /* find key */
01956       i = 0;
01957       while (*c && *c != '=' && *c != ',' && !isspace(*c)) {
01958          key[i++] = *c++;
01959       }
01960       key[i] = '\0';
01961       c = ast_skip_blanks(c);
01962       if (*c == '=') {
01963          c = ast_skip_blanks(++c);
01964          i = 0;
01965          if (*c == '\"') {
01966             /* in quotes. Skip first and look for last */
01967             c++;
01968             while (*c && *c != '\"') {
01969                if (*c == '\\' && c[1] != '\0') { /* unescape chars */
01970                   c++;
01971                }
01972                val[i++] = *c++;
01973             }
01974          } else {
01975             /* token */
01976             while (*c && *c != ',' && !isspace(*c)) {
01977                val[i++] = *c++;
01978             }
01979          }
01980          val[i] = '\0';
01981       }
01982 
01983       while (*c && *c != ',') {
01984          c++;
01985       }
01986       if (*c) {
01987          c++;
01988       }
01989 
01990       if (!strcasecmp(key, "username")) {
01991          ast_string_field_set(d, username, val);
01992       } else if (!strcasecmp(key, "realm")) {
01993          ast_string_field_set(d, realm, val);
01994       } else if (!strcasecmp(key, "nonce")) {
01995          ast_string_field_set(d, nonce, val);
01996       } else if (!strcasecmp(key, "uri")) {
01997          ast_string_field_set(d, uri, val);
01998       } else if (!strcasecmp(key, "domain")) {
01999          ast_string_field_set(d, domain, val);
02000       } else if (!strcasecmp(key, "response")) {
02001          ast_string_field_set(d, response, val);
02002       } else if (!strcasecmp(key, "algorithm")) {
02003          if (strcasecmp(val, "MD5")) {
02004             ast_log(LOG_WARNING, "Digest algorithm: \"%s\" not supported.\n", val);
02005             return -1;
02006          }
02007       } else if (!strcasecmp(key, "cnonce")) {
02008          ast_string_field_set(d, cnonce, val);
02009       } else if (!strcasecmp(key, "opaque")) {
02010          ast_string_field_set(d, opaque, val);
02011       } else if (!strcasecmp(key, "qop") && !strcasecmp(val, "auth")) {
02012          d->qop = 1;
02013       } else if (!strcasecmp(key, "nc")) {
02014          unsigned long u;
02015          if (sscanf(val, "%30lx", &u) != 1) {
02016             ast_log(LOG_WARNING, "Incorrect Digest nc value: \"%s\".\n", val);
02017             return -1;
02018          }
02019          ast_string_field_set(d, nc, val);
02020       }
02021    }
02022    ast_free(str);
02023 
02024    /* Digest checkout */
02025    if (ast_strlen_zero(d->realm) || ast_strlen_zero(d->nonce)) {
02026       /* "realm" and "nonce" MUST be always exist */
02027       return -1;
02028    }
02029 
02030    if (!request) {
02031       /* Additional check for Digest response */
02032       if (ast_strlen_zero(d->username) || ast_strlen_zero(d->uri) || ast_strlen_zero(d->response)) {
02033          return -1;
02034       }
02035 
02036       if (pedantic && d->qop && (ast_strlen_zero(d->cnonce) || ast_strlen_zero(d->nc))) {
02037          return -1;
02038       }
02039    }
02040 
02041    return 0;
02042 }

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

01424 {
01425    char *dataPut = start;
01426    int inEscape = 0;
01427    int inQuotes = 0;
01428 
01429    for (; *start; start++) {
01430       if (inEscape) {
01431          *dataPut++ = *start;       /* Always goes verbatim */
01432          inEscape = 0;
01433       } else {
01434          if (*start == '\\') {
01435             inEscape = 1;      /* Do not copy \ into the data */
01436          } else if (*start == '\'') {
01437             inQuotes = 1 - inQuotes;   /* Do not copy ' into the data */
01438          } else {
01439             /* Replace , with |, unless in quotes */
01440             *dataPut++ = inQuotes ? *start : ((*start == find) ? replace_with : *start);
01441          }
01442       }
01443    }
01444    if (start != dataPut)
01445       *dataPut = 0;
01446    return dataPut;
01447 }

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.

01029 {
01030    unsigned char attr_destroy = 0;
01031    int res;
01032 
01033    if (!attr) {
01034       attr = alloca(sizeof(*attr));
01035       pthread_attr_init(attr);
01036       attr_destroy = 1;
01037    }
01038 
01039    if ((errno = pthread_attr_setdetachstate(attr, PTHREAD_CREATE_DETACHED)))
01040       ast_log(LOG_WARNING, "pthread_attr_setdetachstate: %s\n", strerror(errno));
01041 
01042    res = ast_pthread_create_stack(thread, attr, start_routine, data, 
01043                                   stacksize, file, caller, line, start_fn);
01044 
01045    if (attr_destroy)
01046       pthread_attr_destroy(attr);
01047 
01048    return res;
01049 }

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

00980 {
00981 #if !defined(LOW_MEMORY)
00982    struct thr_arg *a;
00983 #endif
00984 
00985    if (!attr) {
00986       attr = alloca(sizeof(*attr));
00987       pthread_attr_init(attr);
00988    }
00989 
00990 #ifdef __linux__
00991    /* On Linux, pthread_attr_init() defaults to PTHREAD_EXPLICIT_SCHED,
00992       which is kind of useless. Change this here to
00993       PTHREAD_INHERIT_SCHED; that way the -p option to set realtime
00994       priority will propagate down to new threads by default.
00995       This does mean that callers cannot set a different priority using
00996       PTHREAD_EXPLICIT_SCHED in the attr argument; instead they must set
00997       the priority afterwards with pthread_setschedparam(). */
00998    if ((errno = pthread_attr_setinheritsched(attr, PTHREAD_INHERIT_SCHED)))
00999       ast_log(LOG_WARNING, "pthread_attr_setinheritsched: %s\n", strerror(errno));
01000 #endif
01001 
01002    if (!stacksize)
01003       stacksize = AST_STACKSIZE;
01004 
01005    if ((errno = pthread_attr_setstacksize(attr, stacksize ? stacksize : AST_STACKSIZE)))
01006       ast_log(LOG_WARNING, "pthread_attr_setstacksize: %s\n", strerror(errno));
01007 
01008 #if !defined(LOW_MEMORY)
01009    if ((a = ast_malloc(sizeof(*a)))) {
01010       a->start_routine = start_routine;
01011       a->data = data;
01012       start_routine = dummy_start;
01013       if (asprintf(&a->name, "%-20s started at [%5d] %s %s()",
01014               start_fn, line, file, caller) < 0) {
01015          ast_log(LOG_WARNING, "asprintf() failed: %s\n", strerror(errno));
01016          a->name = NULL;
01017       }
01018       data = a;
01019    }
01020 #endif /* !LOW_MEMORY */
01021 
01022    return pthread_create(thread, attr, start_routine, data); /* We're in ast_pthread_create, so it's okay */
01023 }

long int ast_random ( void )

Definition at line 1399 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_new(), ast_rtp_new_source(), ast_udptl_new_with_bindaddr(), auth_http_callback(), authenticate_request(), build_gateway(), build_iv(), build_rand_pad(), build_reply_digest(), calc_metric(), calc_rxstamp(), caldav_write_event(), callno_hash(), dahdi_new(), generate_exchange_uuid(), 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(), 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().

01400 {
01401    long int res;
01402 #ifdef HAVE_DEV_URANDOM
01403    if (dev_urandom_fd >= 0) {
01404       int read_res = read(dev_urandom_fd, &res, sizeof(res));
01405       if (read_res > 0) {
01406          long int rm = RAND_MAX;
01407          res = res < 0 ? ~res : res;
01408          rm++;
01409          return res % rm;
01410       }
01411    }
01412 #endif
01413 #ifdef linux
01414    res = random();
01415 #else
01416    ast_mutex_lock(&randomlock);
01417    res = random();
01418    ast_mutex_unlock(&randomlock);
01419 #endif
01420    return res;
01421 }

void ast_register_thread ( char * name )

Definition at line 379 of file asterisk.c.

References ast_calloc, AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, and AST_RWLIST_WRLOCK.

Referenced by dummy_start().

00380 { 
00381    struct thread_list_t *new = ast_calloc(1, sizeof(*new));
00382 
00383    if (!new)
00384       return;
00385    new->id = pthread_self();
00386    new->name = name; /* steal the allocated memory for the thread name */
00387    AST_RWLIST_WRLOCK(&thread_list);
00388    AST_RWLIST_INSERT_HEAD(&thread_list, new, list);
00389    AST_RWLIST_UNLOCK(&thread_list);
00390 }

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

00236 {
00237 #if defined(SIOCGIFHWADDR)
00238    int s, x = 0;
00239    char eid_str[20];
00240    struct ifreq ifr;
00241 
00242    s = socket(AF_INET, SOCK_STREAM, 0);
00243    if (s < 0)
00244       return;
00245    for (x = 0; x < 10; x++) {
00246       memset(&ifr, 0, sizeof(ifr));
00247       snprintf(ifr.ifr_name, sizeof(ifr.ifr_name), "eth%d", x);
00248       if (ioctl(s, SIOCGIFHWADDR, &ifr))
00249          continue;
00250       memcpy(eid, ((unsigned char *)&ifr.ifr_hwaddr) + 2, sizeof(*eid));
00251       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);
00252       close(s);
00253       return;
00254    }
00255    close(s);
00256 #else
00257 #if defined(ifa_broadaddr) && !defined(SOLARIS)
00258    char eid_str[20];
00259    struct ifaddrs *ifap;
00260    
00261    if (getifaddrs(&ifap) == 0) {
00262       struct ifaddrs *p;
00263       for (p = ifap; p; p = p->ifa_next) {
00264          if ((p->ifa_addr->sa_family == AF_LINK) && !(p->ifa_flags & IFF_LOOPBACK) && (p->ifa_flags & IFF_RUNNING)) {
00265             struct sockaddr_dl* sdp = (struct sockaddr_dl*) p->ifa_addr;
00266             memcpy(&(eid->eid), sdp->sdl_data + sdp->sdl_nlen, 6);
00267             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);
00268             freeifaddrs(ifap);
00269             return;
00270          }
00271       }
00272       freeifaddrs(ifap);
00273    }
00274 #endif
00275 #endif
00276    ast_debug(1, "No ethernet interface found for seeding global EID. You will have to set it manually.\n");
00277 }

void ast_sha1_hash	(	char *	output,
		const 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().

00247 {
00248    struct SHA1Context sha;
00249    char *ptr;
00250    int x;
00251    uint8_t Message_Digest[20];
00252 
00253    SHA1Reset(&sha);
00254    
00255    SHA1Input(&sha, (const unsigned char *) input, strlen(input));
00256 
00257    SHA1Result(&sha, Message_Digest);
00258    ptr = output;
00259    for (x = 0; x < 20; x++)
00260       ptr += sprintf(ptr, "%2.2x", Message_Digest[x]);
00261 }

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

Definition at line 273 of file utils.h.

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

00274 {
00275    int res;
00276 
00277    res = (int) *input + *value;
00278    if (res > 32767)
00279       *input = 32767;
00280    else if (res < -32767)
00281       *input = -32767;
00282    else
00283       *input = (short) res;
00284 }

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

Definition at line 312 of file utils.h.

Referenced by ast_frame_adjust_volume(), and audiohook_read_frame_both().

00313 {
00314    *input /= *value;
00315 }

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

Definition at line 299 of file utils.h.

Referenced by ast_frame_adjust_volume(), and audiohook_read_frame_both().

00300 {
00301    int res;
00302 
00303    res = (int) *input * *value;
00304    if (res > 32767)
00305       *input = 32767;
00306    else if (res < -32767)
00307       *input = -32767;
00308    else
00309       *input = (short) res;
00310 }

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

Definition at line 286 of file utils.h.

Referenced by softmix_bridge_thread().

00287 {
00288    int res;
00289 
00290    res = (int) *input - *value;
00291    if (res > 32767)
00292       *input = 32767;
00293    else if (res < -32767)
00294       *input = -32767;
00295    else
00296       *input = (short) res;
00297 }

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

00280 {
00281    unsigned int eid_int[6];
00282    int x;
00283 
00284    if (sscanf(s, "%2x:%2x:%2x:%2x:%2x:%2x", &eid_int[0], &eid_int[1], &eid_int[2],
00285        &eid_int[3], &eid_int[4], &eid_int[5]) != 6)
00286          return -1;
00287    
00288    for (x = 0; x < 6; x++)
00289       eid->eid[x] = eid_int[x];
00290 
00291    return 0;
00292 }

void ast_unregister_thread ( void * id )

Definition at line 392 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().

00393 {
00394    struct thread_list_t *x;
00395 
00396    AST_RWLIST_WRLOCK(&thread_list);
00397    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&thread_list, x, list) {
00398       if ((void *) x->id == id) {
00399          AST_RWLIST_REMOVE_CURRENT(list);
00400          break;
00401       }
00402    }
00403    AST_RWLIST_TRAVERSE_SAFE_END;
00404    AST_RWLIST_UNLOCK(&thread_list);
00405    if (x) {
00406       ast_free(x->name);
00407       ast_free(x);
00408    }
00409 }

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

00415 {
00416    char *o;
00417    unsigned int tmp;
00418 
00419    for (o = s; *s; s++, o++) {
00420       if (*s == '%' && strlen(s) > 2 && sscanf(s + 1, "%2x", &tmp) == 1) {
00421          /* have '%', two chars and correct parsing */
00422          *o = tmp;
00423          s += 2;  /* Will be incremented once more when we break out */
00424       } else /* all other cases, just copy */
00425          *o = *s;
00426    }
00427    *o = '\0';
00428 }

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 add_rpid(), config_curl(), destroy_curl(), initreqprep(), launch_asyncagi(), realtime_curl(), realtime_multi_curl(), require_curl(), store_curl(), update2_curl(), update_curl(), and uriencode().

00384 {
00385    char *reserved = ";/?:@&=+$,# "; /* Reserved chars */
00386 
00387    const char *ptr  = string; /* Start with the string */
00388    char *out = NULL;
00389    char *buf = NULL;
00390 
00391    ast_copy_string(outbuf, string, buflen);
00392 
00393    /* If there's no characters to convert, just go through and don't do anything */
00394    while (*ptr) {
00395       if ((*ptr < 32 || (unsigned char) *ptr) > 127 || (doreserved && strchr(reserved, *ptr)) ) {
00396          /* Oops, we need to start working here */
00397          if (!buf) {
00398             buf = outbuf;
00399             out = buf + (ptr - string) ;  /* Set output ptr */
00400          }
00401          out += sprintf(out, "%%%02x", (unsigned char) *ptr);
00402       } else if (buf) {
00403          *out = *ptr;   /* Continue copying the string */
00404          out++;
00405       } 
00406       ptr++;
00407    }
00408    if (buf)
00409       *out = '\0';
00410    return outbuf;
00411 }

int ast_utils_init ( void )

Definition at line 1910 of file utils.c.

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

Referenced by main().

01911 {
01912 #ifdef HAVE_DEV_URANDOM
01913    dev_urandom_fd = open("/dev/urandom", O_RDONLY);
01914 #endif
01915    base64_init();
01916 #ifdef DEBUG_THREADS
01917 #if !defined(LOW_MEMORY)
01918    ast_cli_register_multiple(utils_cli, ARRAY_LEN(utils_cli));
01919 #endif
01920 #endif
01921    return 0;
01922 }

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

01052 {
01053    struct pollfd pfd[1];
01054    memset(pfd, 0, sizeof(pfd));
01055    pfd[0].fd = fd;
01056    pfd[0].events = POLLIN|POLLPRI;
01057    return ast_poll(pfd, 1, ms);
01058 }

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

Referenced by ast_event_cb(), ast_event_new(), ast_readconfig(), ast_str_retrieve_variable(), evt_event_deliver_cb(), handle_show_settings(), and set_config().


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) (sizeof(a) / sizeof(0[a]))
#define	ast_asprintf(ret, fmt,...) _ast_asprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, fmt, __VA_ARGS__)
	A wrapper for asprintf().
#define	ast_assert(a)
#define	AST_BACKGROUND_STACKSIZE AST_STACKSIZE
#define	ast_calloc(num, len) _ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	A wrapper for calloc().
#define	ast_calloc_cache(num, len) _ast_calloc((num), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	A wrapper for calloc() for use in cache pools.
#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_free free
	free() wrapper
#define	ast_free_ptr ast_free
#define	ast_malloc(len) _ast_malloc((len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	A wrapper for malloc().
#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_realloc(p, len) _ast_realloc((p), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	A wrapper for realloc().
#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_strdup(str) _ast_strdup((str), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	A wrapper for strdup().
#define	ast_strdupa(s)
	duplicate a string in memory from the stack
#define	ast_strndup(str, len) _ast_strndup((str), (len), __FILE__, __LINE__, __PRETTY_FUNCTION__)
	A wrapper for strndup().
#define	ast_test_flag(p, flag)
#define	ast_test_flag64(p, flag)
#define	ast_test_flag_nonstd(p, flag) ((p)->flags & (flag))
#define	ast_vasprintf(ret, fmt, ap) _ast_vasprintf((ret), __FILE__, __LINE__, __PRETTY_FUNCTION__, (fmt), (ap))
	A wrapper for vasprintf().
#define	localtime_r __dont_use_localtime_r_use_ast_localtime_instead__
#define	MALLOC_FAILURE_MSG ast_log(LOG_ERROR, "Memory Allocation Failure in function %s at line %d of %s\n", func, lineno, file);
#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_asprintf (char *ret, const char file, int lineno, const char func, const char fmt,...)
void *attribute_malloc	_ast_calloc (size_t num, size_t len, const char file, int lineno, const char func)
void *attribute_malloc	_ast_malloc (size_t len, const char file, int lineno, const char func)
void *attribute_malloc	_ast_realloc (void p, size_t len, const char file, int lineno, const char *func)
char *attribute_malloc	_ast_strdup (const char str, const char file, int lineno, const char *func)
char *attribute_malloc	_ast_strndup (const char str, size_t len, const char file, int lineno, const char *func)
int	_ast_vasprintf (char *ret, const char file, int lineno, const char func, const char fmt, va_list ap)
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.
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_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.

Asterisk developer's documentation

utils.h File Reference

Data Structures

Defines

Functions

Variables

Detailed Description

Define Documentation

Function Documentation

Variable Documentation