Sat Nov 1 06:29:22 2008

Asterisk developer's documentation

---

utils.c File Reference

Utility functions. More...

#include "asterisk.h"
#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/lock.h"
#include "asterisk/io.h"
#include "asterisk/logger.h"
#include "asterisk/md5.h"
#include "asterisk/sha1.h"
#include "asterisk/options.h"
#include "asterisk/cli.h"
#include "asterisk/linkedlists.h"
#include "asterisk/strings.h"
#include "asterisk/time.h"
#include "asterisk/stringfields.h"
#include "asterisk/utils.h"
#include "asterisk/threadstorage.h"

Include dependency graph for utils.c:

Go to the source code of this file.

Data Structures
struct	thr_arg
Defines
#define	AST_API_MODULE
#define	AST_API_MODULE
#define	AST_API_MODULE
#define	AST_API_MODULE
#define	AST_API_MODULE
#define	AST_API_MODULE
#define	ERANGE   34
#define	ONE_MILLION   1000000
Functions
ast_string_field	__ast_string_field_alloc_space (struct ast_string_field_mgr *mgr, size_t needed, ast_string_field *fields, int num_fields)
void	__ast_string_field_index_build (struct ast_string_field_mgr *mgr, ast_string_field *fields, int num_fields, int index, const char *format,...)
void	__ast_string_field_index_build_va (struct ast_string_field_mgr *mgr, ast_string_field *fields, int num_fields, int index, const char *format, va_list ap1, va_list ap2)
int	__ast_string_field_init (struct ast_string_field_mgr *mgr, size_t size, ast_string_field *fields, int num_fields)
int	_ast_asprintf (char **ret, const char *file, int lineno, const char *func, const char *fmt,...)
static int	add_string_pool (struct ast_string_field_mgr *mgr, size_t size)
int	ast_atomic_fetchadd_int_slow (volatile int *p, int v)
int	ast_base64decode (unsigned char *dst, const char *src, int max)
	decode BASE64 encoded text
int	ast_base64encode (char *dst, const unsigned char *src, int srclen, int max)
int	ast_base64encode_full (char *dst, const unsigned char *src, int srclen, int max, int linebreaks)
	encode text to BASE64 coding
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.
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_dynamic_str_thread_build_va (struct ast_dynamic_str **buf, size_t max_len, struct ast_threadstorage *ts, int append, const char *fmt, va_list ap)
	Core functionality of ast_dynamic_str_thread_(set|append)_va.
void	ast_enable_packet_fragmentation (int sock)
int	ast_false (const char *s)
int	ast_get_time_t (const char *src, time_t *dst, time_t _default, int *consumed)
	get values from config variables.
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 (struct in_addr ia)
	thread-safe replacement for inet_ntoa().
void	ast_join (char *s, size_t len, char *const w[])
void	ast_md5_hash (char *output, char *input)
	Produce 32 char MD5 hash of value.
	AST_MUTEX_DEFINE_STATIC (fetchadd_m)
	AST_MUTEX_DEFINE_STATIC (randomlock)
	glibc puts a lock inside random(3), so that the results are thread-safe. BSD libc (and others) do not.
	AST_MUTEX_DEFINE_STATIC (test_lock2)
	AST_MUTEX_DEFINE_STATIC (test_lock)
	AST_MUTEX_DEFINE_STATIC (__mutex)
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, const char *file, const char *caller, int line, const char *start_fn)
long int	ast_random (void)
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)
	AST_THREADSTORAGE (inet_ntoa_buf, inet_ntoa_buf_init)
int	ast_true (const char *s)
timeval	ast_tvadd (struct timeval a, struct timeval b)
timeval	ast_tvsub (struct timeval a, struct timeval b)
	Returns the difference of two timevals a - b.
char *	ast_unescape_semicolon (char *s)
	Strip backslash for "escaped" semicolons. s The string to be stripped (will be modified).
void	ast_uri_decode (char *s)
	Decode URI, URN, URL (overwrite string).
char *	ast_uri_encode (const char *string, char *outbuf, int buflen, int doreserved)
	Turn text string to URI-encoded XX version 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.
int	ast_utils_init (void)
int	ast_wait_for_input (int fd, int ms)
static void	base64_init (void)
static void *	dummy_start (void *data)
static int	gethostbyname_r (const char *name, struct hostent *ret, char *buf, size_t buflen, struct hostent **result, int *h_errnop)
	Reentrant replacement for gethostbyname for BSD-based systems.
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)
Variables
const char	__ast_string_field_empty [] = ""
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 64 of file utils.c.

#define AST_API_MODULE

Definition at line 64 of file utils.c.

#define AST_API_MODULE

Definition at line 64 of file utils.c.

#define AST_API_MODULE

Definition at line 64 of file utils.c.

#define AST_API_MODULE

Definition at line 64 of file utils.c.

#define AST_API_MODULE

Definition at line 64 of file utils.c.

#define ERANGE   34

duh? ERANGE value copied from web...

Definition at line 74 of file utils.c.

Referenced by gethostbyname_r(), and reload_queue_members().

#define ONE_MILLION   1000000

Definition at line 1102 of file utils.c.

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

---

Function Documentation

ast_string_field __ast_string_field_alloc_space	(	struct ast_string_field_mgr *	mgr,
		size_t	needed,
		ast_string_field *	fields,
		int	num_fields
	)

Definition at line 1244 of file utils.c.

References add_string_pool(), ast_string_field_pool::base, ast_string_field_mgr::pool, ast_string_field_mgr::size, ast_string_field_mgr::space, and ast_string_field_mgr::used.

{
   char *result = NULL;

   if (__builtin_expect(needed > mgr->space, 0)) {
      size_t new_size = mgr->size * 2;

      while (new_size < needed)
         new_size *= 2;

      if (add_string_pool(mgr, new_size))
         return NULL;
   }

   result = mgr->pool->base + mgr->used;
   mgr->used += needed;
   mgr->space -= needed;
   return result;
}

void __ast_string_field_index_build	(	struct ast_string_field_mgr *	mgr,
		ast_string_field *	fields,
		int	num_fields,
		int	index,
		const char *	format,
			...
	)

Definition at line 1292 of file utils.c.

References __ast_string_field_index_build_va().

{
   va_list ap1, ap2;

   va_start(ap1, format);
   va_start(ap2, format);     /* va_copy does not exist on FreeBSD */

   __ast_string_field_index_build_va(mgr, fields, num_fields, index, format, ap1, ap2);

   va_end(ap1);
   va_end(ap2);
}

void __ast_string_field_index_build_va	(	struct ast_string_field_mgr *	mgr,
		ast_string_field *	fields,
		int	num_fields,
		int	index,
		const char *	format,
		va_list	ap1,
		va_list	ap2
	)

Definition at line 1265 of file utils.c.

References add_string_pool(), ast_string_field_pool::base, ast_string_field_mgr::pool, ast_string_field_mgr::size, ast_string_field_mgr::space, and ast_string_field_mgr::used.

Referenced by __ast_string_field_index_build().

{
   size_t needed;

   needed = vsnprintf(mgr->pool->base + mgr->used, mgr->space, format, ap1) + 1;

   va_end(ap1);

   if (needed > mgr->space) {
      size_t new_size = mgr->size * 2;

      while (new_size < needed)
         new_size *= 2;

      if (add_string_pool(mgr, new_size))
         return;

      vsprintf(mgr->pool->base + mgr->used, format, ap2);
   }

   fields[index] = mgr->pool->base + mgr->used;
   mgr->used += needed;
   mgr->space -= needed;
}

int __ast_string_field_init	(	struct ast_string_field_mgr *	mgr,
		size_t	size,
		ast_string_field *	fields,
		int	num_fields
	)

Definition at line 1230 of file utils.c.

References add_string_pool().

{
   int index;

   if (add_string_pool(mgr, size))
      return -1;

   for (index = 0; index < num_fields; index++)
      fields[index] = __ast_string_field_empty;

   return 0;
}

int _ast_asprintf	(	char **	ret,
		const char *	file,
		int	lineno,
		const char *	func,
		const char *	fmt,
			...
	)

Definition at line 1412 of file utils.c.

References MALLOC_FAILURE_MSG, and vasprintf.

{
   int res;
   va_list ap;

   va_start(ap, fmt);
   if ((res = vasprintf(ret, fmt, ap)) == -1) {
      MALLOC_FAILURE_MSG;
   }
   va_end(ap);

   return res;
}

static int add_string_pool	(	struct ast_string_field_mgr *	mgr,
		size_t	size
	)			[static]

Definition at line 1214 of file utils.c.

References ast_calloc, ast_string_field_mgr::pool, ast_string_field_mgr::size, ast_string_field_mgr::space, and ast_string_field_mgr::used.

Referenced by __ast_string_field_alloc_space(), __ast_string_field_index_build_va(), and __ast_string_field_init().

{
   struct ast_string_field_pool *pool;

   if (!(pool = ast_calloc(1, sizeof(*pool) + size)))
      return -1;
   
   pool->prev = mgr->pool;
   mgr->pool = pool;
   mgr->size = size;
   mgr->space = size;
   mgr->used = 0;

   return 0;
}

int ast_atomic_fetchadd_int_slow	(	volatile int *	p,
		int	v
	)

Definition at line 1309 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
	)

decode BASE64 encoded text

Definition at line 328 of file utils.c.

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

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

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

Definition at line 406 of file utils.c.

References ast_base64encode_full().

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

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

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

encode text to BASE64 coding

Definition at line 355 of file utils.c.

Referenced by ast_base64encode().

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

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

Definition at line 1056 of file utils.c.

References ast_build_string_va().

Referenced by __queues_show(), add_codec_to_sdp(), add_noncodec_to_sdp(), add_sdp(), add_t38_sdp(), ast_cdr_serialize_variables(), ast_http_setcookie(), config_odbc(), config_pgsql(), function_realtime_read(), html_translate(), httpstatus_callback(), initreqprep(), pbx_builtin_serialize_variables(), print_uptimestr(), show_translation(), show_translation_deprecated(), transmit_notify_with_mwi(), transmit_state_notify(), and xml_translate().

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

Referenced by ast_build_string().

{
   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;
}

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.

ast_carefulwrite

Note:

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

Definition at line 975 of file utils.c.

References errno, pollfd::events, pollfd::fd, poll(), and POLLOUT.

Referenced by agi_debug_cli(), ast_cli(), astman_append(), and process_events().

{
   /* Try to write string, but wait no more than ms milliseconds
      before timing out */
   int res = 0;
   struct pollfd fds[1];
   while (len) {
      res = write(fd, s, len);
      if ((res < 0) && (errno != EAGAIN)) {
         return -1;
      }
      if (res < 0)
         res = 0;
      len -= res;
      s += res;
      res = 0;
      if (len) {
         fds[0].fd = fd;
         fds[0].events = POLLOUT;
         /* Wait until writable again */
         res = poll(fds, 1, timeoutms);
         if (res < 1)
            return -1;
      }
   }
   return res;
}

int ast_dynamic_str_thread_build_va	(	struct ast_dynamic_str **	buf,
		size_t	max_len,
		struct ast_threadstorage *	ts,
		int	append,
		const char *	fmt,
		va_list	ap
	)

Core functionality of ast_dynamic_str_thread_(set|append)_va.

The arguments to this function are the same as those described for ast_dynamic_str_thread_set_va except for an addition argument, append. If append is non-zero, this will append to the current string instead of writing over it.

Definition at line 1345 of file utils.c.

References ast_realloc, ast_threadstorage::key, and offset.

{
   int res;
   int offset = (append && (*buf)->len) ? strlen((*buf)->str) : 0;
#if defined(DEBUG_THREADLOCALS)
   struct ast_dynamic_str *old_buf = *buf;
#endif /* defined(DEBUG_THREADLOCALS) */

   res = vsnprintf((*buf)->str + offset, (*buf)->len - offset, fmt, ap);

   /* Check to see if there was not enough space in the string buffer to prepare
    * the string.  Also, if a maximum length is present, make sure the current
    * length is less than the maximum before increasing the size. */
   if ((res + offset + 1) > (*buf)->len && (max_len ? ((*buf)->len < max_len) : 1)) {
      /* Set the new size of the string buffer to be the size needed
       * to hold the resulting string (res) plus one byte for the
       * terminating '\0'.  If this size is greater than the max, set
       * the new length to be the maximum allowed. */
      if (max_len)
         (*buf)->len = ((res + offset + 1) < max_len) ? (res + offset + 1) : max_len;
      else
         (*buf)->len = res + offset + 1;

      if (!(*buf = ast_realloc(*buf, (*buf)->len + sizeof(*(*buf)))))
         return AST_DYNSTR_BUILD_FAILED;

      if (append)
         (*buf)->str[offset] = '\0';

      if (ts) {
         pthread_setspecific(ts->key, *buf);
#if defined(DEBUG_THREADLOCALS)
         __ast_threadstorage_object_replace(old_buf, *buf, (*buf)->len + sizeof(*(*buf)));
#endif /* defined(DEBUG_THREADLOCALS) */
      }

      /* va_end() and va_start() must be done before calling
       * vsnprintf() again. */
      return AST_DYNSTR_BUILD_RETRY;
   }

   return res;
}

void ast_enable_packet_fragmentation

(

int

sock

)

Definition at line 1390 of file utils.c.

References ast_log(), and LOG_WARNING.

Referenced by ast_netsock_bindaddr().

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

int ast_false

(

const char *

val

)

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

References ast_strlen_zero().

Referenced by aji_create_client(), aji_load_config(), ast_rtp_reload(), ast_udptl_reload(), handle_common_options(), init_acf_query(), load_config(), load_odbc_config(), reload(), run_agi(), set_insecure_flags(), and strings_to_mask().

{
   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;
}

int ast_get_time_t	(	const char *	src,
		time_t *	dst,
		time_t	_default,
		int *	consumed
	)

get values from config variables.

Definition at line 1322 of file utils.c.

References ast_strlen_zero(), and t.

Referenced by acf_strftime(), build_peer(), cache_lookup_internal(), handle_saydatetime(), load_password(), play_message_datetime(), and sayunixtime_exec().

{
   long t;
   int scanned;

   if (dst == NULL)
      return -1;

   *dst = _default;

   if (ast_strlen_zero(src))
      return -1;

   /* only integer at the moment, but one day we could accept more formats */
   if (sscanf(src, "%ld%n", &t, &scanned) == 1) {
      *dst = t;
      if (consumed)
         *consumed = scanned;
      return 0;
   } else
      return -1;
}

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

Definition at line 184 of file utils.c.

References gethostbyname_r(), hp, and s.

Referenced by __ast_http_load(), __set_address_from_contact(), ast_dnsmgr_lookup(), ast_find_ourip(), ast_get_ip_or_srv(), ast_sip_ouraddrfor(), check_via(), create_addr(), dnsmgr_refresh(), festival_exec(), gtalk_load_config(), gtalk_update_stun(), iax_template_parse(), launch_netscript(), parse_register_contact(), process_sdp(), realtime_peer(), realtime_user(), reload_config(), rtcp_do_debug_ip(), rtcp_do_debug_ip_deprecated(), rtp_do_debug_ip(), set_config(), set_destination(), sip_devicestate(), sip_do_debug_ip(), and udptl_do_debug_ip().

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

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

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

const char* ast_inet_ntoa

(

struct in_addr

ia

)

thread-safe replacement for inet_ntoa().

Note:

It is very important to note that even though this is a thread-safe replacement for inet_ntoa(), it is *not* reentrant. In a single thread, the result from a previous call to this function is no longer valid once it is called again. If the result from multiple calls to this function need to be kept or used at once, then the result must be copied to a local buffer before calling this function again.

Definition at line 495 of file utils.c.

Referenced by __attempt_transmit(), __find_callno(), __iax2_show_peers(), __sip_show_channels(), __sip_xmit(), _sip_show_peer(), _sip_show_peers(), accept_thread(), add_sdp(), add_t38_sdp(), ast_apply_ha(), ast_netsock_bindaddr(), ast_rtcp_read(), ast_rtcp_write_rr(), ast_rtcp_write_sr(), ast_rtp_raw_write(), ast_rtp_read(), ast_rtp_sendcng(), ast_rtp_senddigit_begin(), ast_rtp_senddigit_continuation(), ast_rtp_senddigit_end(), ast_sip_ouraddrfor(), ast_udptl_bridge(), ast_udptl_read(), ast_udptl_write(), authenticate(), bridge_native_loop(), bridge_p2p_rtp_write(), build_callid_pvt(), build_callid_registry(), build_contact(), build_peer(), build_reply_digest(), build_rpid(), build_via(), check_access(), check_user_full(), check_via(), copy_via_headers(), create_addr_from_peer(), dnsmgr_refresh(), dump_addr(), dump_ipaddr(), dundi_rexmit(), dundi_show_peer(), dundi_show_peers(), dundi_show_trans(), dundi_showframe(), dundi_xmit(), external_rtp_create(), find_command(), find_peer(), find_subchannel_and_lock(), function_iaxpeer(), function_sipchaninfo_read(), function_sippeer(), gtalk_create_candidates(), gtalk_update_stun(), handle_command_response(), handle_error(), handle_open_receive_channel_ack_message(), handle_request(), handle_request_bye(), handle_request_register(), handle_request_subscribe(), handle_response(), handle_response_refer(), handle_show_http(), handle_showmanconn(), http_server_start(), httpstatus_callback(), iax2_ack_registry(), iax2_prov_app(), 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_addrcmp_str(), oh323_call(), oh323_set_rtp_peer(), parse_register_contact(), 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(), rtcp_do_debug_ip(), rtcp_do_debug_ip_deprecated(), rtp_do_debug_ip(), send_dtmf(), send_packet(), send_request(), send_response(), send_trunk(), session_do(), set_config(), set_destination(), setup_incoming_call(), sip_do_debug_ip(), sip_do_debug_peer(), sip_handle_t38_reinvite(), sip_poke_peer(), sip_set_rtp_peer(), sip_set_udptl_peer(), sip_show_channel(), sip_show_settings(), sipsock_read(), skinny_session(), skinny_show_devices(), socket_process(), timing_read(), transmit_notify_with_mwi(), udptl_do_debug_ip(), and update_registry().

{
   char *buf;

   if (!(buf = ast_threadstorage_get(&inet_ntoa_buf, INET_ADDRSTRLEN)))
      return "";

   return inet_ntop(AF_INET, &ia, buf, INET_ADDRSTRLEN);
}

void ast_join	(	char *	s,
		size_t	len,
		char *const	w[]
	)

Definition at line 1193 of file utils.c.

Referenced by __ast_cli_generator(), __ast_cli_register(), ast_builtins_init(), console_sendtext(), console_sendtext_deprecated(), find_best(), handle_agidumphtml(), handle_help(), handle_showagi(), help1(), and help_workhorse().

{
   int x, ofs = 0;
   const char *src;

   /* Join words into a string */
   if (!s)
      return;
   for (x = 0; ofs < len && w[x]; x++) {
      if (x > 0)
         s[ofs++] = ' ';
      for (src = w[x]; *src && ofs < len; src++)
         s[ofs++] = *src;
   }
   if (ofs == len)
      ofs--;
   s[ofs] = '\0';
}

void ast_md5_hash	(	char *	output,
		char *	input
	)

Produce 32 char MD5 hash of value.

Definition at line 294 of file utils.c.

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

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

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

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

AST_MUTEX_DEFINE_STATIC

(

fetchadd_m

)

AST_MUTEX_DEFINE_STATIC

(

randomlock

)

glibc puts a lock inside random(3), so that the results are thread-safe. BSD libc (and others) do not.

AST_MUTEX_DEFINE_STATIC

(

test_lock2

)

AST_MUTEX_DEFINE_STATIC

(

test_lock

)

AST_MUTEX_DEFINE_STATIC

(

__mutex

)

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

Referenced by handle_context_add_extension(), handle_context_add_extension_deprecated(), and pbx_load_config().

{
   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;
}

<