utils.c File Reference

Utility functions. More...

#include <ctype.h>
#include <string.h>
#include <unistd.h>
#include <stdlib.h>
#include <errno.h>
#include <stdarg.h>
#include <stdio.h>
#include <sys/types.h>
#include <sys/socket.h>
#include <netinet/in.h>
#include <arpa/inet.h>
#include "asterisk.h"
#include "asterisk/lock.h"
#include "asterisk/io.h"
#include "asterisk/logger.h"
#include "asterisk/md5.h"
#include "asterisk/sha1.h"
#include "asterisk/options.h"
#include "asterisk/compat.h"
#include "asterisk/strings.h"
#include "asterisk/time.h"
#include "asterisk/utils.h"

Include dependency graph for utils.c:

Go to the source code of this file.

Defines
#define	AST_API_MODULE
#define	AST_API_MODULE
#define	AST_API_MODULE
#define	AST_API_MODULE
#define	LONG_MAX   9223372036854775807L
#define	LONG_MIN   (-9223372036854775807L-1L)
#define	ONE_MILLION   1000000
Functions
int	ast_atomic_fetchadd_int_slow (volatile int *p, int v)
int	ast_base64decode (unsigned char *dst, const char *src, int max)
int	ast_base64encode (char *dst, const unsigned char *src, int srclen, int max)
int	ast_build_string (char **buffer, size_t *space, const char *fmt,...)
int	ast_build_string_va (char **buffer, size_t *space, const char *fmt, va_list ap)
	Build a string in a buffer, designed to be called repeatedly.
void	ast_enable_packet_fragmentation (int sock)
	Disable PMTU discovery on a socket.
int	ast_false (const char *s)
struct hostent *	ast_gethostbyname (const char *host, struct ast_hostent *hp)
	Re-entrant (thread safe) version of gethostbyname that replaces the standard gethostbyname (which is not thread safe).
const char *	ast_inet_ntoa (char *buf, int bufsiz, struct in_addr ia)
	ast_inet_ntoa: Recursive thread safe replacement of inet_ntoa
void	ast_md5_hash (char *output, char *input)
	ast_md5_hash: Produce 16 char MD5 hash of value. ---
	AST_MUTEX_DEFINE_STATIC (fetchadd_m)
	AST_MUTEX_DEFINE_STATIC (test_lock2)
	AST_MUTEX_DEFINE_STATIC (test_lock)
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_stack (pthread_t *thread, pthread_attr_t *attr, void *(*start_routine)(void *), void *data, size_t stacksize)
void	ast_sha1_hash (char *output, char *input)
	Produce 40 char SHA1 hash of value.
char *	ast_strip_quoted (char *s, const char *beg_quotes, const char *end_quotes)
int	ast_true (const char *s)
struct timeval	ast_tvadd (struct timeval a, struct timeval b)
struct timeval	ast_tvsub (struct timeval a, struct timeval b)
	Returns the difference of two timevals a - b.
void	ast_uri_decode (char *s)
	ast_uri_decode: Decode SIP URI, URN, URL (overwrite the string) ---
char *	ast_uri_encode (char *string, char *outbuf, int buflen, int doreserved)
	ast_uri_encode: Turn text string to URI-encoded XX version ---
int	ast_utils_init (void)
int	ast_wait_for_input (int fd, int ms)
static void	base64_init (void)
int	getloadavg (double *list, int nelem)
char *	strcasestr (const char *haystack, const char *needle)
char *	strndup (const char *s, size_t n)
size_t	strnlen (const char *s, size_t n)
uint64_t	strtoq (const char *nptr, char **endptr, int base)
int	test_for_thread_safety (void)
static void *	test_thread_body (void *data)
	This is a regression test for recursive mutexes. test_for_thread_safety() will return 0 if recursive mutex locks are working properly, and non-zero if they are not working properly.
static struct timeval	tvfix (struct timeval a)
static char *	upper (const char *orig, char *buf, int bufsize)
int	vasprintf (char **strp, const char *fmt, va_list ap)
Variables
static char	b2a [256]
static char	base64 [64]
static int	lock_count = 0
static int	test_errors = 0
static pthread_t	test_thread

---

Detailed Description

Utility functions.

Note:

These are important for portability and security, so please use them in favour of other routines. Please consult the CODING GUIDELINES for more information.

Definition in file utils.c.

---

Define Documentation

#define AST_API_MODULE

Definition at line 58 of file utils.c.

#define AST_API_MODULE

Definition at line 58 of file utils.c.

#define AST_API_MODULE

Definition at line 58 of file utils.c.

#define AST_API_MODULE

Definition at line 58 of file utils.c.

#define LONG_MAX   9223372036854775807L

Definition at line 764 of file utils.c.

Referenced by strtoq().

#define LONG_MIN   (-9223372036854775807L-1L)

Definition at line 760 of file utils.c.

Referenced by strtoq().

#define ONE_MILLION   1000000

Definition at line 620 of file utils.c.

Referenced by ast_tvadd(), ast_tvsub(), and tvfix().

---

Function Documentation

int ast_atomic_fetchadd_int_slow	(	volatile int *	p,
		int	v
	)

Definition at line 933 of file utils.c.

References ast_mutex_lock(), and ast_mutex_unlock().

{
        int ret;
        ast_mutex_lock(&fetchadd_m);
        ret = *p;
        *p += v;
        ast_mutex_unlock(&fetchadd_m);
        return ret;
}

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

Definition at line 319 of file utils.c.

Referenced by __ast_check_signature(), and ast_osp_validate().

{
   int cnt = 0;
   unsigned int byte = 0;
   unsigned int bits = 0;
   int incnt = 0;
#if 0
   unsigned char *odst = dst;
#endif
   while(*src && (cnt < max)) {
      /* Shift in 6 bits of input */
      byte <<= 6;
      byte |= (b2a[(int)(*src)]) & 0x3f;
      bits += 6;
#if 0
      printf("Add: %c %s\n", *src, binary(b2a[(int)(*src)] & 0x3f, 6));
#endif
      src++;
      incnt++;
      /* If we have at least 8 bits left over, take that character 
         off the top */
      if (bits >= 8)  {
         bits -= 8;
         *dst = (byte >> bits) & 0xff;
#if 0
         printf("Remove: %02x %s\n", *dst, binary(*dst, 8));
#endif
         dst++;
         cnt++;
      }
   }
#if 0
   dump(odst, cnt);
#endif
   /* Dont worry about left over bits, they're extra anyway */
   return cnt;
}

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

Definition at line 357 of file utils.c.

Referenced by __ast_sign(), ast_osp_lookup(), ast_osp_next(), and build_secret().

{
   int cnt = 0;
   unsigned int byte = 0;
   int bits = 0;
   int index;
   int cntin = 0;
#if 0
   char *odst = dst;
   dump(src, srclen);
#endif
   /* Reserve one bit for end */
   max--;
   while((cntin < srclen) && (cnt < max)) {
      byte <<= 8;
#if 0
      printf("Add: %02x %s\n", *src, binary(*src, 8));
#endif
      byte |= *(src++);
      bits += 8;
      cntin++;
      while((bits >= 6) && (cnt < max)) {
         bits -= 6;
         /* We want only the top */
         index = (byte >> bits) & 0x3f;
         *dst = base64[index];
#if 0
         printf("Remove: %c %s\n", *dst, binary(index, 6));
#endif
         dst++;
         cnt++;
      }
   }
   if (bits && (cnt < max)) {
      /* Add one last character for the remaining bits, 
         padding the rest with 0 */
      byte <<= (6 - bits);
      index = (byte) & 0x3f;
      *(dst++) = base64[index];
      cnt++;
   }
   *dst = '\0';
   return cnt;
}

int ast_build_string	(	char **	buffer,
		size_t *	space,
		const char *	fmt,
			...
	)

Definition at line 574 of file utils.c.

References ast_build_string_va().

Referenced by __queues_show(), add_codec_to_sdp(), add_noncodec_to_sdp(), add_sdp(), ast_cdr_serialize_variables(), config_odbc(), initreqprep(), manager_event(), pbx_builtin_serialize_variables(), skinny_call(), transmit_notify_with_mwi(), and transmit_state_notify().

{
   va_list ap;
   int result;

   va_start(ap, fmt);
   result = ast_build_string_va(buffer, space, fmt, ap);
   va_end(ap);

   return result;
}

int ast_build_string_va	(	char **	buffer,
		size_t *	space,
		const char *	fmt,
		va_list	ap
	)

Build a string in a buffer, designed to be called repeatedly.

This is a wrapper for snprintf, that properly handles the buffer pointer and buffer space available.

Returns:

0 on success, non-zero on failure.

Parameters:

	buffer	current position in buffer to place string into (will be updated on return)
	space	remaining space in buffer (will be updated on return)
	fmt	printf-style format string
	ap	varargs list of arguments for format

Definition at line 555 of file utils.c.

Referenced by ast_build_string(), and manager_event().

{
   int result;

   if (!buffer || !*buffer || !space || !*space)
      return -1;

   result = vsnprintf(*buffer, *space, fmt, ap);

   if (result < 0)
      return -1;
   else if (result > *space)
      result = *space;

   *buffer += result;
   *space -= result;
   return 0;
}

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

References ast_log(), and LOG_WARNING.

Referenced by ast_netsock_bindaddr(), and reload_config().

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

int ast_false

(

const char *

val

)

Make sure something is false

Determine if a string containing a boolean value is "false". This function checks to see whether a string passed to it is an indication of an "false" value. It checks to see if the string is "no", "false", "n", "f", "off" or "0".

Returns 0 if val is a NULL pointer, -1 if "false", and 0 otherwise.

Definition at line 603 of file utils.c.

References ast_strlen_zero().

Referenced by ast_rtp_reload(), ast_strings_to_mask(), build_peer(), build_user(), handle_common_options(), and pbx_load_module().

{
   if (ast_strlen_zero(s))
      return 0;

   /* Determine if this is a false value */
   if (!strcasecmp(s, "no") ||
       !strcasecmp(s, "false") ||
       !strcasecmp(s, "n") ||
       !strcasecmp(s, "f") ||
       !strcasecmp(s, "0") ||
       !strcasecmp(s, "off"))
      return -1;

   return 0;
}

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

Re-entrant (thread safe) version of gethostbyname that replaces the standard gethostbyname (which is not thread safe).

Definition at line 176 of file utils.c.

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

Referenced by ast_dnsmgr_lookup(), ast_find_ourip(), ast_get_ip_or_srv(), ast_sip_ouraddrfor(), build_peer(), check_via(), create_addr(), festival_exec(), iax2_register(), iax_template_parse(), launch_netscript(), parse_ok_contact(), parse_register_contact(), process_sdp(), realtime_peer(), realtime_user(), refresh_list(), reload_config(), rpt_exec(), rtp_do_debug_ip(), set_config(), set_destination(), sip_devicestate(), and sip_do_debug_ip().

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

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

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

const char* ast_inet_ntoa	(	char *	buf,
		int	bufsiz,
		struct in_addr	ia
	)

ast_inet_ntoa: Recursive thread safe replacement of inet_ntoa

Definition at line 486 of file utils.c.

Referenced by __iax2_show_peers(), __sip_show_channels(), __sip_xmit(), _sip_show_peer(), _sip_show_peers(), add_sdp(), ast_apply_ha(), ast_netsock_bindaddr(), ast_osp_validate(), ast_rtcp_read(), ast_rtp_bridge(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_sendcng(), ast_rtp_senddigit(), ast_sip_ouraddrfor(), attempt_transmit(), authenticate(), build_callid(), build_contact(), build_reply_digest(), build_rpid(), build_via(), calltoken_required(), check_access(), check_user_full(), check_via(), copy_via_headers(), create_addr_from_peer(), dump_addr(), dump_ipaddr(), dundi_rexmit(), dundi_show_peer(), dundi_show_peers(), dundi_show_trans(), dundi_showframe(), dundi_xmit(), external_rtp_create(), find_callno(), find_command(), find_peer(), find_subchannel_and_lock(), find_tpeer(), find_user(), function_iaxpeer(), function_sipchaninfo_read(), function_sippeer(), get_input(), handle_call_token(), handle_command_response(), handle_error(), handle_message(), handle_request(), handle_request_bye(), handle_request_register(), handle_request_subscribe(), handle_response(), handle_showmanconn(), iax2_ack_registry(), iax2_prov_app(), iax2_show_callnumber_usage(), iax2_show_channels(), iax2_show_peer(), iax2_show_registry(), iax2_trunk_queue(), iax_server(), iax_showframe(), initreqprep(), load_module(), mgcp_show_endpoints(), mgcpsock_read(), oh323_call(), oh323_set_rtp_peer(), parse_register_contact(), peercnt_add(), peercnt_modify(), peercnt_remove(), process_message(), process_rfc3389(), process_sdp(), raw_hangup(), realtime_peer(), realtime_update_peer(), realtime_user(), reg_source_db(), register_verify(), registry_rerequest(), reload_config(), resend_response(), retrans_pkt(), rpt_exec(), rtp_do_debug_ip(), sched_delay_remove(), send_dtmf(), send_packet(), send_request(), send_response(), send_trunk(), session_do(), set_config(), set_destination(), set_peercnt_limit(), setup_incoming_call(), sip_do_debug_ip(), sip_do_debug_peer(), sip_new(), sip_poke_peer(), sip_set_rtp_peer(), sip_show_channel(), sip_show_settings(), sipsock_read(), skinny_session(), skinny_show_devices(), socket_read(), timing_read(), transmit_notify_with_mwi(), and update_registry().

{
   return inet_ntop(AF_INET, &ia, buf, bufsiz);
}

void ast_md5_hash	(	char *	output,
		char *	input
	)

ast_md5_hash: Produce 16 char MD5 hash of value. ---

Definition at line 286 of file utils.c.

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

Referenced by auth_exec(), build_reply_digest(), builtin_function_checkmd5(), builtin_function_md5(), check_auth(), md5_exec(), and md5check_exec().

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

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

AST_MUTEX_DEFINE_STATIC

(

fetchadd_m

)

AST_MUTEX_DEFINE_STATIC

(

test_lock2

)

AST_MUTEX_DEFINE_STATIC

(

test_lock

)

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

Referenced by __build_step(), handle_context_add_extension(), and pbx_load_module().

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

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

int ast_pthread_create_stack	(	pthread_t *	thread,
		pthread_attr_t *	attr,
		void *(*)(void *)	start_routine,
		void *	data,
		size_t	stacksize
	)

Definition at line 501 of file utils.c.

References ast_log(), AST_STACKSIZE, LOG_WARNING, and pthread_create.

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

   if (!stacksize)
      stacksize = AST_STACKSIZE;
   errno = pthread_attr_setstacksize(attr, stacksize);
   if (errno)
      ast_log(LOG_WARNING, "pthread_attr_setstacksize returned non-zero: %s\n", strerror(errno));
   return pthread_create(thread, attr, start_routine, data); /* We're in ast_pthread_create, so it's okay */
}

void ast_sha1_hash	(	char *	output,
		char *	input
	)

Produce 40 char SHA1 hash of value.

Definition at line 302 of file utils.c.

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

Referenced by handle_call_token().

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

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

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

char* ast_strip_quoted	(	char *	s,
		const char *	beg_quotes,
		const char *	end_quotes
	)

Definition at line 538 of file utils.c.

Referenced by ast_register_file_version(), builtin_function_if(), builtin_function_iftime(), and parse_dial_string().

{
   char *e;
   char *q;

   s = ast_strip(s);
   if ((q = strchr(beg_quotes, *s)) && *q != '\0') {
      e = s + strlen(s) - 1;
      if (*e == *(end_quotes + (q - beg_quotes))) {
         s++;
         *e = '\0';
      }
   }

   return s;
}

int ast_true

(

const char *

val

)

Make sure something is true

Determine if a string containing a boolean value is "true". This function checks to see whether a string passed to it is an indication of an "true" value. It checks to see if the string is "yes", "true", "y", "t", "on" or "1".

Returns 0 if val is a NULL pointer, -1 if "true", and 0 otherwise.

Definition at line 586 of file utils.c.

References ast_strlen_zero().

Referenced by __load_resource(), __login_exec(), _parse(), action_agent_callback_login(), action_agent_logoff(), action_originate(), action_setcdruserfield(), apply_option(), ast_readconfig(), ast_strings_to_mask(), build_device(), build_gateway(), build_peer(), build_user(), config_load(), dial_exec_full(), do_reload(), festival_exec(), function_ilink(), get_encrypt_methods(), handle_common_options(), init_logger_chain(), init_manager(), load_config(), load_module(), load_modules(), load_moh_classes(), load_odbc_config(), loadconfigurationfile(), manager_add_queue_member(), manager_pause_queue_member(), odbc_load_module(), parse_config(), pbx_load_module(), queue_set_param(), read_agent_config(), reload_config(), reload_queues(), rpt_master(), set_config(), setup_zap(), start_monitor_action(), and update_common_options().

{
   if (ast_strlen_zero(s))
      return 0;

   /* Determine if this is a true value */
   if (!strcasecmp(s, "yes") ||
       !strcasecmp(s, "true") ||
       !strcasecmp(s, "y") ||
       !strcasecmp(s, "t") ||
       !strcasecmp(s, "1") ||
       !strcasecmp(s, "on"))
      return -1;

   return 0;
}

struct timeval ast_tvadd	(	struct timeval	a,
		struct timeval	b
	)			[read]

Definition at line 640 of file utils.c.

References ONE_MILLION, and tvfix().

Referenced by agent_hangup(), agent_read(), ast_channel_bridge(), ast_channel_spy_trigger_wait(), ast_rtp_sendcng(), ast_rtp_senddigit(), ast_sched_runq(), ast_smoother_read(), ast_translate(), calc_rxstamp(), calc_timestamp(), do_cdr(), get_from_jb(), monmp3thread(), mp3_exec(), NBScat_exec(), sched_settime(), and schedule_delivery().

{
   /* consistency checks to guarantee usec in 0..999999 */
   a = tvfix(a);
   b = tvfix(b);
   a.tv_sec += b.tv_sec;
   a.tv_usec += b.tv_usec;
   if (a.tv_usec >= ONE_MILLION) {
      a.tv_sec++;
      a.tv_usec -= ONE_MILLION;
   }
   return a;
}

struct timeval ast_tvsub	(	struct timeval	a,
		struct timeval	b
	)			[read]

Returns the difference of two timevals a - b.

Definition at line 654 of file utils.c.

References ONE_MILLION, and tvfix().

Referenced by ast_channel_bridge(), ast_sched_dump(), ast_translate(), calc_rxstamp(), and calc_timestamp().

{
   /* consistency checks to guarantee usec in 0..999999 */
   a = tvfix(a);
   b = tvfix(b);
   a.tv_sec -= b.tv_sec;
   a.tv_usec -= b.tv_usec;
   if (a.tv_usec < 0) {
      a.tv_sec-- ;
      a.tv_usec += ONE_MILLION;
   }
   return a;
}

void ast_uri_decode

(

char *

s

)

ast_uri_decode: Decode SIP URI, URN, URL (overwrite the string) ---

Decode URI, URN, URL (overwrite string).

Definition at line 469 of file utils.c.

Referenced by builtin_function_uridecode(), check_user_full(), get_destination(), get_refer_info(), and register_verify().

{
   char *o;
   unsigned int tmp;

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

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

ast_uri_encode: Turn text string to URI-encoded XX version ---

Turn text string to URI-encoded XX version 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.

Definition at line 438 of file utils.c.

Referenced by builtin_function_uriencode(), and initreqprep().

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

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

   strncpy(outbuf, string, buflen);

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

int ast_utils_init

(

void

)

Definition at line 491 of file utils.c.

References base64_init().

Referenced by main().

{
   base64_init();
   return 0;
}

int ast_wait_for_input	(	int	fd,
		int	ms
	)

Definition at line 529 of file utils.c.

References pollfd::events, pollfd::fd, poll(), POLLIN, and POLLPRI.

Referenced by ast_moh_destroy().

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

static void base64_init

(

void

)

[static]

Definition at line 402 of file utils.c.

Referenced by ast_utils_init().

{
   int x;
   memset(b2a, -1, sizeof(b2a));
   /* Initialize base-64 Conversion table */
   for (x=0;x<26;x++) {
      /* A-Z */
      base64[x] = 'A' + x;
      b2a['A' + x] = x;
      /* a-z */
      base64[x + 26] = 'a' + x;
      b2a['a' + x] = x + 26;
      /* 0-9 */
      if (x < 10) {
         base64[x + 52] = '0' + x;
         b2a['0' + x] = x + 52;
      }
   }
   base64[62] = '+';
   base64[63] = '/';
   b2a[(int)'+'] = 62;
   b2a[(int)'/'] = 63;
}

int getloadavg	(	double *	list,
		int	nelem
	)

Definition at line 883 of file utils.c.

Referenced by ast_readconfig(), and increase_call_count().

{
   int i;

   for (i = 0; i < nelem; i++) {
      list[i] = 0.1;
   }
   return -1;
}

char* strcasestr	(	const char *	haystack,
		const char *	needle
	)

Definition at line 684 of file utils.c.

References ast_log(), LOG_ERROR, offset, and upper().

Referenced by anti_injection(), do_directory(), find_sdp(), gettag(), handle_response_register(), handle_show_applications(), modlist_modentry(), parse_register_contact(), playback_exec(), realtime_multi_odbc(), realtime_odbc(), reqprep(), respprep(), and sip_sipredirect().

{
   char *u1, *u2;
   int u1len = strlen(haystack) + 1, u2len = strlen(needle) + 1;

   u1 = alloca(u1len);
   u2 = alloca(u2len);
   if (u1 && u2) {
      char *offset;
      if (u2len > u1len) {
         /* Needle bigger than haystack */
         return NULL;
      }
      offset = strstr(upper(haystack, u1, u1len), upper(needle, u2, u2len));
      if (offset) {
         /* Return the offset into the original string */
         return ((char *)((unsigned long)haystack + (unsigned long)(offset - u1)));
      } else {
         return NULL;
      }
   } else {
      ast_log(LOG_ERROR, "Out of memory\n");
      return NULL;
   }
}

char* strndup	(	const char *	s,
		size_t	n
	)

Definition at line 725 of file utils.c.

References malloc, and strnlen().

{
   size_t len = strnlen(s, n);
   char *new = malloc(len + 1);

   if (!new)
      return NULL;

   new[len] = '\0';
   return memcpy(new, s, len);
}

size_t strnlen	(	const char *	s,
		size_t	n
	)

Definition at line 712 of file utils.c.

Referenced by strndup().

{
   size_t len;

   for (len=0; len < n; len++)
      if (s[len] == '\0')
         break;

   return len;
}

uint64_t strtoq	(	const char *	nptr,
		char **	endptr,
		int	base
	)

Definition at line 774 of file utils.c.

References LONG_MAX, LONG_MIN, and s.

{
    const char *s;
    uint64_t acc;
    unsigned char c;
    uint64_t qbase, cutoff;
    int neg, any, cutlim;

    /*
     * Skip white space and pick up leading +/- sign if any.
     * If base is 0, allow 0x for hex and 0 for octal, else
     * assume decimal; if base is already 16, allow 0x.
     */
    s = nptr;
    do {
            c = *s++;
    } while (isspace(c));
    if (c == '-') {
            neg = 1;
            c = *s++;
    } else {
            neg = 0;
            if (c == '+')
                    c = *s++;
    }
    if ((base == 0 || base == 16) &&
        c == '\0' && (*s == 'x' || *s == 'X')) {
            c = s[1];
            s += 2;
            base = 16;
    }
    if (base == 0)
            base = c == '\0' ? 8 : 10;

    /*
     * Compute the cutoff value between legal numbers and illegal
     * numbers.  That is the largest legal value, divided by the
     * base.  An input number that is greater than this value, if
     * followed by a legal input character, is too big.  One that
     * is equal to this value may be valid or not; the limit
     * between valid and invalid numbers is then based on the last
     * digit.  For instance, if the range for quads is
     * [-9223372036854775808..9223372036854775807] and the input base
     * is 10, cutoff will be set to 922337203685477580 and cutlim to
     * either 7 (neg==0) or 8 (neg==1), meaning that if we have
     * accumulated a value > 922337203685477580, or equal but the
     * next digit is > 7 (or 8), the number is too big, and we will
     * return a range error.
     *
     * Set any if any `digits' consumed; make it negative to indicate
     * overflow.
     */
    qbase = (unsigned)base;
    cutoff = neg ? (uint64_t)-(LONG_MIN + LONG_MAX) + LONG_MAX : LONG_MAX;
    cutlim = cutoff % qbase;
    cutoff /= qbase;
    for (acc = 0, any = 0;; c = *s++) {
            if (!isascii(c))
                    break;
            if (isdigit(c))
                    c -= '\0';
            else if (isalpha(c))
                    c -= isupper(c) ? 'A' - 10 : 'a' - 10;
            else
                    break;
            if (c >= base)
                    break;
            if (any < 0 || acc > cutoff || (acc == cutoff && c > cutlim))
                    any = -1;
            else {
                    any = 1;
                    acc *= qbase;
                    acc += c;
            }
    }
    if (any < 0) {
            acc = neg ? LONG_MIN : LONG_MAX;
    } else if (neg)
            acc = -acc;
    if (endptr != 0)
            *((const char **)endptr) = any ? s - 1 : nptr;
    return acc;
}

int test_for_thread_safety

(

void

)

Definition at line 257 of file utils.c.

References ast_mutex_lock(), ast_mutex_unlock(), ast_pthread_create, and test_thread_body().

Referenced by main().

{ 
   ast_mutex_lock(&test_lock2);
   ast_mutex_lock(&test_lock);
   lock_count += 1;
   ast_mutex_lock(&test_lock);
   lock_count += 1;
   ast_pthread_create(&test_thread, NULL, test_thread_body, NULL); 
   usleep(100);
   if (lock_count != 2) 
      test_errors++;
   ast_mutex_unlock(&test_lock);
   lock_count -= 1;
   usleep(100); 
   if (lock_count != 1) 
      test_errors++;
   ast_mutex_unlock(&test_lock);
   lock_count -= 1;
   if (lock_count != 0) 
      test_errors++;
   ast_mutex_unlock(&test_lock2);
   usleep(100);
   if (lock_count != 0) 
      test_errors++;
   pthread_join(test_thread, NULL);
   return(test_errors);          /* return 0 on success. */
}

static void* test_thread_body

(

void *

data

)

[static]

This is a regression test for recursive mutexes. test_for_thread_safety() will return 0 if recursive mutex locks are working properly, and non-zero if they are not working properly.

Definition at line 234 of file utils.c.

References ast_mutex_lock(), and ast_mutex_unlock().

Referenced by test_for_thread_safety().

{ 
   ast_mutex_lock(&test_lock);
   lock_count += 10;
   if (lock_count != 10) 
      test_errors++;
   ast_mutex_lock(&test_lock);
   lock_count += 10;
   if (lock_count != 20) 
      test_errors++;
   ast_mutex_lock(&test_lock2);
   ast_mutex_unlock(&test_lock);
   lock_count -= 10;
   if (lock_count != 10) 
      test_errors++;
   ast_mutex_unlock(&test_lock);
   lock_count -= 10;
   ast_mutex_unlock(&test_lock2);
   if (lock_count != 0) 
      test_errors++;
   return NULL;
} 

static struct timeval tvfix

(

struct timeval

a

)

[static, read]

Definition at line 625 of file utils.c.

References ast_log(), LOG_WARNING, and ONE_MILLION.

Referenced by ast_tvadd(), and ast_tvsub().

{
   if (a.tv_usec >= ONE_MILLION) {
      ast_log(LOG_WARNING, "warning too large timestamp %ld.%ld\n",
         a.tv_sec, (long int) a.tv_usec);
      a.tv_sec += a.tv_usec / ONE_MILLION;
      a.tv_usec %= ONE_MILLION;
   } else if (a.tv_usec < 0) {
      ast_log(LOG_WARNING, "warning negative timestamp %ld.%ld\n",
         a.tv_sec, (long int) a.tv_usec);
      a.tv_usec = 0;
   }
   return a;
}

static char* upper	(	const char *	orig,
		char *	buf,
		int	bufsize
	)			[static]

Definition at line 670 of file utils.c.

Referenced by strcasestr().

{
   int i = 0;

   while (i < (bufsize - 1) && orig[i]) {
      buf[i] = toupper(orig[i]);
      i++;
   }

   buf[i] = '\0';

   return buf;
}

int vasprintf	(	char **	strp,
		const char *	fmt,
		va_list	ap
	)

Definition at line 739 of file utils.c.

References malloc, and s.

{
   int size;
   va_list ap2;
   char s;

   *strp = NULL;
   va_copy(ap2, ap);
   size = vsnprintf(&s, 1, fmt, ap2);
   va_end(ap2);
   *strp = malloc(size + 1);
   if (!*strp)
      return -1;
   vsnprintf(*strp, size + 1, fmt, ap);

   return size;
}

---

Variable Documentation

char b2a[256] [static]

Definition at line 62 of file utils.c.

char base64[64] [static]

Definition at line 61 of file utils.c.

int lock_count = 0 [static]

Definition at line 228 of file utils.c.

int test_errors = 0 [static]

Definition at line 229 of file utils.c.

pthread_t test_thread [static]

Definition at line 227 of file utils.c.