Mon Jun 27 16:51:22 2011

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)   (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 * _ast_calloc (size_t num, size_t len, const char *file, int lineno, const char *func)
void * _ast_malloc (size_t len, const char *file, int lineno, const char *func)
void * _ast_realloc (void *p, size_t len, const char *file, int lineno, const char *func)
char * _ast_strdup (const char *str, const char *file, int lineno, const char *func)
char * _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.
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 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)

Variables

unsigned int __unsigned_int_flags_dummy
uint64_t __unsigned_int_flags_dummy64
ast_eid ast_eid_default
 Global EID.


Detailed Description

Utility functions.

Definition in file utils.h.


Define Documentation

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

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

#define ast_assert (  ) 

Definition at line 710 of file utils.h.

Referenced by _ast_odbc_request_obj2(), append_ie(), ast_cc_is_recall(), ast_channel_get_cc_config_params(), ast_hangup(), ast_rtcp_read(), ast_rtp_read(), ast_sched_del(), ast_udptl_read(), cc_generic_agent_start_monitoring(), cc_generic_agent_start_offer_timer(), cc_generic_monitor_cancel_available_timer(), check_callback_sanity(), create_jb(), create_new_sip_etag(), determine_sip_publish_type(), find_timer(), handle_response_publish(), jb_get_and_deliver(), pthread_timer_ack(), publish_expire(), read_pipe(), security_event_cb(), sig_pri_call(), sip_cc_agent_init(), and sip_cc_monitor_unsuspend().

#define AST_BACKGROUND_STACKSIZE   AST_STACKSIZE

Definition at line 367 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 464 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 489 of file utils.h.

#define ast_clear_flag ( p,
flag   ) 

Definition at line 77 of file utils.h.

Referenced by __analog_ss_thread(), __ast_read(), __do_deliver(), __transmit_response(), aji_create_client(), aji_filter_roster(), 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_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_hold_state(), change_spy_mode(), channel_spy(), chanspy_exec(), check_goto_on_transfer(), check_pendings(), common_exec(), config_function_read(), config_text_file_load(), create_addr_from_peer(), dahdi_read(), dahdiscan_exec(), dial_exec_full(), dictate_exec(), disa_exec(), dundi_lookup_local(), extenspy_exec(), forward_message(), 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(), linear_alloc(), load_config(), load_moh_classes(), local_ast_moh_stop(), local_attended_transfer(), local_hangup(), main(), manage_parkinglot(), 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_alloc(), sip_call(), sip_dtmfmode(), sip_hangup(), socket_process(), speech_background(), 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(), find_conf(), iax2_destroy_helper(), iax2_setoption(), set_config(), set_config_destroy(), and socket_process().

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

Definition at line 84 of file utils.h.

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

#define ast_copy_flags64 ( dest,
src,
flagz   ) 

Definition at line 141 of file utils.h.

Referenced by __find_callno(), build_peer(), build_user(), check_access(), create_addr(), dial_exec_full(), iax2_request(), 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

Definition at line 196 of file utils.h.

Referenced by add_features_datastores(), aji_create_client(), ast_cdr_reset(), ast_cdr_specialized_reset(), builtin_atxfer(), cache_lookup_internal(), channel_spy(), chanspy_exec(), check_goto_on_transfer(), dahdiscan_exec(), dundi_lookup_local(), extenspy_exec(), feature_interpret(), handle_queue_reload(), load_module(), load_moh_classes(), manager_queue_reload(), park_exec_full(), parse_options(), populate_defaults(), reload(), and set_config_flags().

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

#define ast_free_ptr   ast_free

Definition at line 426 of file utils.h.

Referenced by add_extensions(), ast_extension_state(), 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_users(), register_exten(), and register_peer_exten().

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

#define ast_pthread_create ( a,
b,
c,
 ) 

Value:

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

Definition at line 381 of file utils.h.

Referenced by accept_thread(), ast_bridge_impart(), ast_dial_run(), ast_features_init(), ast_taskprocessor_get(), bridge_call_thread_launch(), bridge_channel_join(), function_autopatchup(), handle_callforward_button(), handle_enbloc_call_message(), handle_offhook_message(), handle_soft_key_event_message(), handle_stimulus_message(), handle_transfer_button(), HandleCallOutgoing(), init_logger(), load_module(), local_dtmf_helper(), restart_monitor(), rpt_master(), rpt_telemetry(), sla_load_config(), and start_poll_thread().

#define ast_pthread_create_background ( a,
b,
c,
 ) 

Value:

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

Definition at line 389 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_safe_fork(), ast_sched_thread_create(), ast_tcptls_server_start(), astdb_init(), calendar_event_notify(), conf_run(), config_load(), do_reload(), find_idle_thread(), init_app_class(), init_timing_thread(), load_module(), local_ast_moh_start(), pri_dchannel(), restart_monitor(), restart_pktc_thread(), sip_prepare_socket(), start_network_thread(), start_stream(), store_config(), and usbradio_call().

#define ast_pthread_create_detached ( a,
b,
c,
 ) 

Value:

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

Definition at line 385 of file utils.h.

Referenced by __analog_handle_event(), action_originate(), analog_handle_init_event(), analog_ss_thread_start(), ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_pbx_start(), dahdi_handle_event(), dundi_answer_entity(), dundi_answer_query(), handle_hd_hf(), handle_init_event(), launch_service(), main(), mwi_thread(), and spawn_dp_lookup().

#define ast_pthread_create_detached_background ( a,
b,
c,
 ) 

Value:

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

Definition at line 394 of file utils.h.

Referenced by ast_cdr_submit_batch(), ast_tcptls_server_root(), cc_generic_agent_recall(), conf_run(), 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 500 of file utils.h.

#define ast_set2_flag ( p,
value,
flag   ) 

Definition at line 94 of file utils.h.

Referenced by _macro_exec(), aji_create_client(), aji_load_config(), apply_general_options(), apply_option(), apply_outgoing(), ast_bridge_call(), ast_jb_read_conf(), ast_plc_reload(), ast_tls_read_conf(), ast_translate(), build_peer(), dial_exec_full(), do_reload(), find_account(), find_user(), handle_common_options(), handle_t38_options(), load_config(), load_module(), load_moh_classes(), local_ast_moh_start(), and sip_setoption().

#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_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_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_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(), 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(), handle_common_options(), handle_exec(), 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(), linear_alloc(), load_config(), load_moh_classes(), local_alloc(), local_ast_moh_start(), local_attended_transfer(), local_call(), local_hangup(), login_exec(), main(), manage_parkinglot(), manager_queue_reload(), manager_sipnotify(), minivm_greet_exec(), nocdr_exec(), odbc_load_module(), park_call_full(), park_exec_full(), parse_options(), playtones_alloc(), post_cdr(), process_cn_rfc3389(), process_crypto(), process_sdp(), qualify_peer(), record_exec(), register_verify(), ring_entry(), rpt(), rpt_call(), rpt_exec(), rpt_tele_thread(), set_bridge_features_on_config(), set_config_flags(), set_insecure_flags(), sip_answer(), sip_call(), sip_cc_agent_init(), sip_cc_agent_respond(), sip_cli_notify(), sip_dtmfmode(), sip_hangup(), sip_indicate(), sip_poke_peer(), sip_reinvite_retry(), sip_send_mwi_to_peer(), sip_sendhtml(), sip_set_rtp_peer(), sip_set_udptl_peer(), sip_write(), 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   ) 

Definition at line 127 of file utils.h.

Referenced by authenticate_reply(), authenticate_request(), build_peer(), build_user(), check_access(), conf_run(), decrypt_frame(), dial_exec_full(), handle_cli_iax2_prune_realtime(), iax2_predestroy(), iax2_provision(), iax2_setoption(), iax2_start_transfer(), parse_options(), peer_delme_cb(), pvt_destructor(), run_station(), set_config(), sla_station_exec(), sla_trunk_exec(), 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 362 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 527 of file utils.h.

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

Definition at line 621 of file utils.h.

Referenced by __ast_channel_alloc_ap(), __ast_play_and_record(), _ast_device_state(), _build_port_config(), _macro_exec(), _parse(), _while_exec(), 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_join_exec(), aji_leave_exec(), aji_send_exec(), aji_sendgroup_exec(), aji_status_exec(), 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_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_eivr_senddtmf(), ast_eivr_setvariable(), ast_el_add_history(), ast_filehelper(), ast_format_str_reduce(), ast_func_read(), ast_func_read2(), ast_func_write(), ast_get_group(), ast_hook_send_action(), ast_http_get_cookies(), ast_mkdir(), ast_monitor_change_fname(), ast_monitor_start(), ast_netsock_bind(), ast_ouraddrfor(), ast_parse_allow_disallow(), ast_parse_arg(), ast_pickup_call(), 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(), astman_get_variables(), asyncgoto_exec(), auth_exec(), authenticate_reply(), authenticate_verify(), background_detect_exec(), bridge_exec(), bridge_play_sounds(), build_channels(), build_mapping(), build_peer(), build_profile(), build_user(), builtin_atxfer(), builtin_automixmonitor(), builtin_automonitor(), cache_get_callno_locked(), callerid_read(), 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(), complete_meetmecmd(), 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_followme_number(), create_queue_member(), create_vmaccount(), cut_internal(), dahdi_send_callrerouting_facility_exec(), 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_forward(), do_immediate_setup(), do_message(), 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(), extenspy_exec(), feature_interpret(), festival_exec(), fileexists_core(), find_conf_realtime(), find_gtalk(), find_sdp(), find_table(), find_table_cb(), findmeexec(), function_agent(), function_iaxpeer(), function_realtime_store(), generic_recall(), get_cid_name(), get_destination(), get_pai(), get_refer_info(), gosub_exec(), 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_mfcr2_set_debug(), handle_mgcp_audit_endpoint(), handle_options(), handle_request_invite(), handle_request_notify(), handle_request_subscribe(), 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_config(), load_dynamic_module(), local_call(), local_devicestate(), log_exec(), logger_print_normal(), 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(), moh_handle_digit(), monitor_dial(), multicast_rtp_request(), my_pri_make_cc_dialstring(), 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(), park_space_reserve(), parkandannounce_exec(), parse_allowed_methods(), parse_apps(), parse_empty_options(), parse_events(), parse_register_contact(), parse_session_expires(), 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_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_echocancel(), process_sdp(), process_sdp_o(), ql_exec(), queue_exec(), queue_mwi_event(), queue_set_param(), rcvfax_exec(), read_exec(), readexten_exec(), readfile_exec(), realtime_common(), realtime_exec(), realtime_multi_curl(), realtime_multi_ldap(), realtime_multi_odbc(), realtime_multi_pgsql(), receivefax_exec(), record_exec(), redirecting_read(), redirecting_write(), register_verify(), registry_authrequest(), reload_followme(), reload_single_member(), resource_name_match(), retrydial_exec(), rpt_exec(), rqm_exec(), rtcp_do_debug_ip(), rtp_do_debug_ip(), saycountedadj_exec(), saycountednoun_exec(), sayunixtime_exec(), senddtmf_exec(), sendfax_exec(), sendmail(), sendurl_exec(), set_config_flags(), setup_privacy_args(), sig_pri_extract_called_num_subaddr(), sig_pri_msn_match(), sip_devicestate(), sip_get_cc_information(), sip_new(), sip_show_settings(), sip_sipredirect(), 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(), start_moh_exec(), start_monitor_action(), start_monitor_exec(), state_notify_build_xml(), stun_monitor_request(), timezone_add(), transfer_exec(), transmit_invite(), transmit_refer(), 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(), xmldoc_get_syntax_fun(), 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 556 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(), _ast_odbc_request_obj2(), _macro_exec(), _sip_show_peer(), _sip_show_peers(), 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_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_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_moh_files_next(), ast_quiet_chan(), ast_raw_answer(), ast_readstring_full(), ast_rtp_raw_write(), ast_sendtext(), 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(), 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(), 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(), forward_message(), free_user(), function_sippeer(), get_destination(), get_insecure_variable_from_config(), get_rpid(), gosub_exec(), handle_cli_moh_show_classes(), handle_cli_wait_fullybooted(), handle_command_response(), handle_exec(), handle_frame(), handle_minivm_show_settings(), handle_options(), handle_request_bye(), handle_request_cancel(), handle_request_info(), handle_request_invite(), handle_request_refer(), handle_request_subscribe(), handle_response(), handle_response_invite(), handle_response_notify(), handle_show_settings(), handle_showchan(), handle_skinny_show_settings(), handle_speechrecognize(), handle_tcptls_connection(), hint_read(), iax2_write(), 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_hangup(), local_indicate(), local_write(), main(), make_email_file(), manager_list_voicemail_users(), 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(), notify_new_message(), odbc_load_module(), 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_crypto(), process_sdp(), process_sdp_a_audio(), process_sdp_o(), process_text_line(), read_exec(), readexten_exec(), realtime_switch_common(), receivefax_exec(), record_exec(), redirecting_write(), register_verify(), reload_config(), reload_handler(), reload_queues(), reload_single_queue(), remove_from_queue(), reqprep(), respprep(), retrans_pkt(), retrydial_exec(), rpt_master(), search_directory_sub(), 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(), sig_pri_call(), sip_alloc(), sip_call(), sip_cc_agent_destructor(), 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(), 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(), action_meetmelist(), admin_exec(), ast_app_options2str64(), ast_cli_netstats(), authenticate_reply(), authenticate_request(), authenticate_verify(), build_peer(), build_user(), can_write(), check_access(), complete_iax2_peers(), conf_exec(), conf_run(), decrypt_frame(), dial_exec_full(), do_forward(), find_conf(), function_iaxpeer(), handle_cli_iax2_prune_realtime(), handle_cli_iax2_show_channels(), handle_cli_iax2_show_peer(), handle_cli_iax2_show_users(), iax2_call(), iax2_destroy_helper(), iax2_getpeertrunk(), iax2_hangup(), iax2_indicate(), iax2_predestroy(), iax2_queryoption(), iax2_request(), iax2_send(), iax2_trunk_queue(), iax2_write(), log_jitterstats(), manager_iax2_show_peer_list(), peers_data_provider_get(), prune_peers(), prune_users(), realtime_update_peer(), reg_source_db(), register_verify(), retrydial_exec(), schedule_delivery(), send_trunk(), set_config(), setup_privacy_args(), socket_process(), update_registry(), user_set_kickme_cb(), user_set_muted_cb(), user_set_unmuted_cb(), users_data_provider_get(), 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 595 of file utils.h.

#define localtime_r   __dont_use_localtime_r_use_ast_localtime_instead__

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

Referenced by _ast_asprintf().

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

Definition at line 228 of file utils.h.

Referenced by __ast_answer(), handle_mousedown(), handle_response_register(), and sdl_setup().

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

Definition at line 226 of file utils.h.

Referenced by 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 2072 of file utils.c.

References MALLOC_FAILURE_MSG, and vasprintf.

02073 {
02074    int res;
02075    va_list ap;
02076 
02077    va_start(ap, fmt);
02078    if ((res = vasprintf(ret, fmt, ap)) == -1) {
02079       MALLOC_FAILURE_MSG;
02080    }
02081    va_end(ap);
02082 
02083    return res;
02084 }

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

Definition at line 477 of file utils.h.

00505 {

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

Definition at line 454 of file utils.h.

00469 {

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

Definition at line 513 of file utils.h.

00532 {

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

Definition at line 542 of file utils.h.

00561 {

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

Definition at line 571 of file utils.h.

00601 {

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

Definition at line 609 of file utils.h.

00623 {                                                                \

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

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

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

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

References ast_base64encode_full().

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

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

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

encode text to BASE64 coding

Definition at line 294 of file utils.c.

Referenced by ast_base64encode().

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

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

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

Referenced by send_string().

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

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.

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

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

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 aji_devstate_cb(), aji_handle_pubsub_event(), aji_mwi_cb(), ast_event_cb(), build_peer(), build_transactions(), destroy_trans(), dundi_answer_entity(), dundi_answer_query(), dundi_ie_append_eid_appropriately(), dundi_lookup_internal(), dundi_query_thread(), evt_event_deliver_cb(), find_peer(), 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 aji_publish_device_state(), aji_publish_mwi(), append_transaction(), ast_set_default_eid(), ast_str_retrieve_variable(), 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().

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

References ast_log(), and LOG_WARNING.

Referenced by ast_netsock_bindaddr().

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

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

Thread-safe gethostbyname function to use in Asterisk.

Definition at line 183 of file utils.c.

References hp.

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

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

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

Produces MD5 hash based on input string.

Definition at line 233 of file utils.c.

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

Referenced by build_reply_digest(), and md5().

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

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 1902 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(), reload_logger(), remove_from_queue(), setup_privacy_args(), sms_nextoutgoing(), sms_writefile(), testclient_exec(), testserver_exec(), and write_history().

01903 {
01904    char *ptr;
01905    int len = strlen(path), count = 0, x, piececount = 0;
01906    char *tmp = ast_strdupa(path);
01907    char **pieces;
01908    char *fullpath = alloca(len + 1);
01909    int res = 0;
01910 
01911    for (ptr = tmp; *ptr; ptr++) {
01912       if (*ptr == '/')
01913          count++;
01914    }
01915 
01916    /* Count the components to the directory path */
01917    pieces = alloca(count * sizeof(*pieces));
01918    for (ptr = tmp; *ptr; ptr++) {
01919       if (*ptr == '/') {
01920          *ptr = '\0';
01921          pieces[piececount++] = ptr + 1;
01922       }
01923    }
01924 
01925    *fullpath = '\0';
01926    for (x = 0; x < piececount; x++) {
01927       /* This looks funky, but the buffer is always ideally-sized, so it's fine. */
01928       strcat(fullpath, "/");
01929       strcat(fullpath, pieces[x]);
01930       res = mkdir(fullpath, mode);
01931       if (res && errno != EEXIST)
01932          return errno;
01933    }
01934    return 0;
01935 }

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 1959 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, str, ast_http_digest::uri, and ast_http_digest::username.

01959                                                                                                {
01960    int i;
01961    char *c, key[512], val[512], tmp[512];
01962    struct ast_str *str = ast_str_create(16);
01963 
01964    if (ast_strlen_zero(digest) || !d || !str) {
01965       ast_free(str);
01966       return -1;
01967    }
01968 
01969    ast_str_set(&str, 0, "%s", digest);
01970 
01971    c = ast_skip_blanks(ast_str_buffer(str));
01972 
01973    if (strncasecmp(tmp, "Digest ", strlen("Digest "))) {
01974       ast_log(LOG_WARNING, "Missing Digest.\n");
01975       ast_free(str);
01976       return -1;
01977    }
01978    c += strlen("Digest ");
01979 
01980    /* lookup for keys/value pair */
01981    while (*c && *(c = ast_skip_blanks(c))) {
01982       /* find key */
01983       i = 0;
01984       while (*c && *c != '=' && *c != ',' && !isspace(*c)) {
01985          key[i++] = *c++;
01986       }
01987       key[i] = '\0';
01988       c = ast_skip_blanks(c);
01989       if (*c == '=') {
01990          c = ast_skip_blanks(++c);
01991          i = 0;
01992          if (*c == '\"') {
01993             /* in quotes. Skip first and look for last */
01994             c++;
01995             while (*c && *c != '\"') {
01996                if (*c == '\\' && c[1] != '\0') { /* unescape chars */
01997                   c++;
01998                }
01999                val[i++] = *c++;
02000             }
02001          } else {
02002             /* token */
02003             while (*c && *c != ',' && !isspace(*c)) {
02004                val[i++] = *c++;
02005             }
02006          }
02007          val[i] = '\0';
02008       }
02009 
02010       while (*c && *c != ',') {
02011          c++;
02012       }
02013       if (*c) {
02014          c++;
02015       }
02016 
02017       if (!strcasecmp(key, "username")) {
02018          ast_string_field_set(d, username, val);
02019       } else if (!strcasecmp(key, "realm")) {
02020          ast_string_field_set(d, realm, val);
02021       } else if (!strcasecmp(key, "nonce")) {
02022          ast_string_field_set(d, nonce, val);
02023       } else if (!strcasecmp(key, "uri")) {
02024          ast_string_field_set(d, uri, val);
02025       } else if (!strcasecmp(key, "domain")) {
02026          ast_string_field_set(d, domain, val);
02027       } else if (!strcasecmp(key, "response")) {
02028          ast_string_field_set(d, response, val);
02029       } else if (!strcasecmp(key, "algorithm")) {
02030          if (strcasecmp(val, "MD5")) {
02031             ast_log(LOG_WARNING, "Digest algorithm: \"%s\" not supported.\n", val);
02032             return -1;
02033          }
02034       } else if (!strcasecmp(key, "cnonce")) {
02035          ast_string_field_set(d, cnonce, val);
02036       } else if (!strcasecmp(key, "opaque")) {
02037          ast_string_field_set(d, opaque, val);
02038       } else if (!strcasecmp(key, "qop") && !strcasecmp(val, "auth")) {
02039          d->qop = 1;
02040       } else if (!strcasecmp(key, "nc")) {
02041          unsigned long u;
02042          if (sscanf(val, "%30lx", &u) != 1) {
02043             ast_log(LOG_WARNING, "Incorrect Digest nc value: \"%s\".\n", val);
02044             return -1;
02045          }
02046          ast_string_field_set(d, nc, val);
02047       }
02048    }
02049    ast_free(str);
02050 
02051    /* Digest checkout */
02052    if (ast_strlen_zero(d->realm) || ast_strlen_zero(d->nonce)) {
02053       /* "realm" and "nonce" MUST be always exist */
02054       return -1;
02055    }
02056 
02057    if (!request) {
02058       /* Additional check for Digest response */
02059       if (ast_strlen_zero(d->username) || ast_strlen_zero(d->uri) || ast_strlen_zero(d->response)) {
02060          return -1;
02061       }
02062 
02063       if (pedantic && d->qop && (ast_strlen_zero(d->cnonce) || ast_strlen_zero(d->nc))) {
02064          return -1;
02065       }
02066    }
02067 
02068    return 0;
02069 }

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

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

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

References ast_log(), ast_pthread_create_stack(), errno, and LOG_WARNING.

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

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

References asprintf, ast_log(), ast_malloc, AST_STACKSIZE, dummy_start(), errno, LOG_WARNING, and pthread_create.

Referenced by ast_pthread_create_detached_stack().

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

long int ast_random ( void   ) 

Definition at line 1406 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(), authenticate_request(), build_iv(), build_rand_pad(), build_reply_digest(), calc_metric(), calc_rxstamp(), caldav_write_event(), callno_hash(), create_channel_name(), generate_exchange_uuid(), generate_random_string(), 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(), 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(), and try_firmware().

01407 {
01408    long int res;
01409 #ifdef HAVE_DEV_URANDOM
01410    if (dev_urandom_fd >= 0) {
01411       int read_res = read(dev_urandom_fd, &res, sizeof(res));
01412       if (read_res > 0) {
01413          long int rm = RAND_MAX;
01414          res = res < 0 ? ~res : res;
01415          rm++;
01416          return res % rm;
01417       }
01418    }
01419 #endif
01420 #ifdef linux
01421    res = random();
01422 #else
01423    ast_mutex_lock(&randomlock);
01424    res = random();
01425    ast_mutex_unlock(&randomlock);
01426 #endif
01427    return res;
01428 }

void ast_register_thread ( char *  name  ) 

Definition at line 386 of file asterisk.c.

References ast_calloc, AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, and ast_atexit::list.

Referenced by dummy_start().

00387 { 
00388    struct thread_list_t *new = ast_calloc(1, sizeof(*new));
00389 
00390    if (!new)
00391       return;
00392    new->id = pthread_self();
00393    new->name = name; /* steal the allocated memory for the thread name */
00394    AST_RWLIST_WRLOCK(&thread_list);
00395    AST_RWLIST_INSERT_HEAD(&thread_list, new, list);
00396    AST_RWLIST_UNLOCK(&thread_list);
00397 }

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(), and ast_eid::eid.

Referenced by ast_readconfig().

00236 {
00237 #if defined(SIOCGIFHWADDR) && defined(HAVE_STRUCT_IFREQ_IFR_IFRU_IFRU_HWADDR)
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 249 of file utils.c.

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

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

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

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

Definition at line 276 of file utils.h.

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

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

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

Definition at line 315 of file utils.h.

Referenced by ast_frame_adjust_volume(), and audiohook_read_frame_both().

00316 {
00317    *input /= *value;
00318 }

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

Definition at line 302 of file utils.h.

Referenced by ast_frame_adjust_volume(), and audiohook_read_frame_both().

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

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

Definition at line 289 of file utils.h.

Referenced by softmix_bridge_thread().

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

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

00400 {
00401    struct thread_list_t *x;
00402 
00403    AST_RWLIST_WRLOCK(&thread_list);
00404    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&thread_list, x, list) {
00405       if ((void *) x->id == id) {
00406          AST_RWLIST_REMOVE_CURRENT(list);
00407          break;
00408       }
00409    }
00410    AST_RWLIST_TRAVERSE_SAFE_END;
00411    AST_RWLIST_UNLOCK(&thread_list);
00412    if (x) {
00413       ast_free(x->name);
00414       ast_free(x);
00415    }
00416 }

void ast_uri_decode ( char *  s  ) 

Decode URI, URN, URL (overwrite string).

Parameters:
s String to be decoded

Definition at line 419 of file utils.c.

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

00420 {
00421    char *o;
00422    unsigned int tmp;
00423 
00424    for (o = s; *s; s++, o++) {
00425       if (*s == '%' && s[1] != '\0' && s[2] != '\0' && sscanf(s + 1, "%2x", &tmp) == 1) {
00426          /* have '%', two chars and correct parsing */
00427          *o = tmp;
00428          s += 2;  /* Will be incremented once more when we break out */
00429       } else /* all other cases, just copy */
00430          *o = *s;
00431    }
00432    *o = '\0';
00433 }

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

00387 {
00388    const char *ptr  = string; /* Start with the string */
00389    char *out = outbuf;
00390    const char *mark = "-_.!~*'()"; /* no encode set, RFC 2396 section 2.3, RFC 3261 sec 25 */
00391 
00392    while (*ptr && out - outbuf < buflen - 1) {
00393       if ((const signed char) *ptr < 32 || *ptr == 0x7f || *ptr == '%' ||
00394             (do_special_char &&
00395             !(*ptr >= '0' && *ptr <= '9') &&      /* num */
00396             !(*ptr >= 'A' && *ptr <= 'Z') &&      /* ALPHA */
00397             !(*ptr >= 'a' && *ptr <= 'z') &&      /* alpha */
00398             !strchr(mark, *ptr))) {               /* mark set */
00399          if (out - outbuf >= buflen - 3) {
00400             break;
00401          }
00402 
00403          out += sprintf(out, "%%%02X", (unsigned char) *ptr);
00404       } else {
00405          *out = *ptr;   /* Continue copying the string */
00406          out++;
00407       }
00408       ptr++;
00409    }
00410 
00411    if (buflen) {
00412       *out = '\0';
00413    }
00414 
00415    return outbuf;
00416 }

int ast_utils_init ( void   ) 

Definition at line 1937 of file utils.c.

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

Referenced by main().

01938 {
01939 #ifdef HAVE_DEV_URANDOM
01940    dev_urandom_fd = open("/dev/urandom", O_RDONLY);
01941 #endif
01942    base64_init();
01943 #ifdef DEBUG_THREADS
01944 #if !defined(LOW_MEMORY)
01945    ast_cli_register_multiple(utils_cli, ARRAY_LEN(utils_cli));
01946 #endif
01947 #endif
01948    return 0;
01949 }

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

References ast_strdupa, and strsep().

Referenced by ast_bt_get_symbols().

02088 {
02089    const char *envPATH = getenv("PATH");
02090    char *tpath, *path;
02091    struct stat unused;
02092    if (!envPATH) {
02093       return NULL;
02094    }
02095    tpath = ast_strdupa(envPATH);
02096    while ((path = strsep(&tpath, ":"))) {
02097       snprintf(fullpath, fullpath_size, "%s/%s", path, binary);
02098       if (!stat(fullpath, &unused)) {
02099          return fullpath;
02100       }
02101    }
02102    return NULL;
02103 }

int ast_wait_for_input ( int  fd,
int  ms 
)

Definition at line 1056 of file utils.c.

References ast_poll.

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

01057 {
01058    struct pollfd pfd[1];
01059    memset(pfd, 0, sizeof(pfd));
01060    pfd[0].fd = fd;
01061    pfd[0].events = POLLIN|POLLPRI;
01062    return ast_poll(pfd, 1, ms);
01063 }


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 188 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 Mon Jun 27 16:51:22 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7