2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1998-2015 The OpenLDAP Foundation.
5 * Portions Copyright 1998 A. Hartgers.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
17 * This work was initially developed by Bart Hartgers for inclusion in
22 * util-int.c Various functions to replace missing threadsafe ones.
23 * Without the real *_r funcs, things will
24 * work, but might not be threadsafe.
29 #include <ac/stdlib.h>
32 #include <ac/socket.h>
33 #include <ac/string.h>
35 #include <ac/unistd.h>
40 /* newer systems declare this in <netdb.h> for you, older ones don't.
41 * harmless to declare it again (unless defined by a macro).
47 # define HSTRERROR(e) hstrerror(e)
49 # define HSTRERROR(e) hp_strerror(e)
52 #ifndef LDAP_R_COMPILE
53 # undef HAVE_REENTRANT_FUNCTIONS
55 # undef HAVE_GETHOSTBYNAME_R
56 # undef HAVE_GETHOSTBYADDR_R
59 # include <ldap_pvt_thread.h>
60 ldap_pvt_thread_mutex_t ldap_int_resolv_mutex;
61 ldap_pvt_thread_mutex_t ldap_int_hostname_mutex;
62 static ldap_pvt_thread_mutex_t ldap_int_gettime_mutex;
64 # if (defined( HAVE_CTIME_R ) || defined( HAVE_REENTRANT_FUNCTIONS)) \
65 && defined( CTIME_R_NARGS )
68 static ldap_pvt_thread_mutex_t ldap_int_ctime_mutex;
71 /* USE_GMTIME_R and USE_LOCALTIME_R defined in ldap_pvt.h */
74 /* to be released with 2.5 */
75 #if !defined( USE_GMTIME_R ) || !defined( USE_LOCALTIME_R )
76 /* we use the same mutex for gmtime(3) and localtime(3)
77 * because implementations may use the same buffer
78 * for both functions */
79 static ldap_pvt_thread_mutex_t ldap_int_gmtime_mutex;
81 #else /* ! LDAP_DEVEL */
82 ldap_pvt_thread_mutex_t ldap_int_gmtime_mutex;
83 #endif /* ! LDAP_DEVEL */
85 # if defined(HAVE_GETHOSTBYNAME_R) && \
86 (GETHOSTBYNAME_R_NARGS < 5) || (6 < GETHOSTBYNAME_R_NARGS)
87 /* Don't know how to handle this version, pretend it's not there */
88 # undef HAVE_GETHOSTBYNAME_R
90 # if defined(HAVE_GETHOSTBYADDR_R) && \
91 (GETHOSTBYADDR_R_NARGS < 7) || (8 < GETHOSTBYADDR_R_NARGS)
92 /* Don't know how to handle this version, pretend it's not there */
93 # undef HAVE_GETHOSTBYADDR_R
95 #endif /* LDAP_R_COMPILE */
97 char *ldap_pvt_ctime( const time_t *tp, char *buf )
100 # if (CTIME_R_NARGS > 3) || (CTIME_R_NARGS < 2)
101 # error "CTIME_R_NARGS should be 2 or 3"
102 # elif CTIME_R_NARGS > 2 && defined(CTIME_R_RETURNS_INT)
103 return( ctime_r(tp,buf,26) < 0 ? 0 : buf );
104 # elif CTIME_R_NARGS > 2
105 return ctime_r(tp,buf,26);
107 return ctime_r(tp,buf);
112 LDAP_MUTEX_LOCK( &ldap_int_ctime_mutex );
113 AC_MEMCPY( buf, ctime(tp), 26 );
114 LDAP_MUTEX_UNLOCK( &ldap_int_ctime_mutex );
120 #if !defined( USE_GMTIME_R ) || !defined( USE_LOCALTIME_R )
122 ldap_pvt_gmtime_lock( void )
124 # ifndef LDAP_R_COMPILE
126 # else /* LDAP_R_COMPILE */
127 return ldap_pvt_thread_mutex_lock( &ldap_int_gmtime_mutex );
128 # endif /* LDAP_R_COMPILE */
132 ldap_pvt_gmtime_unlock( void )
134 # ifndef LDAP_R_COMPILE
136 # else /* LDAP_R_COMPILE */
137 return ldap_pvt_thread_mutex_unlock( &ldap_int_gmtime_mutex );
138 # endif /* LDAP_R_COMPILE */
140 #endif /* !USE_GMTIME_R || !USE_LOCALTIME_R */
144 ldap_pvt_gmtime( const time_t *timep, struct tm *result )
148 LDAP_MUTEX_LOCK( &ldap_int_gmtime_mutex );
149 tm_ptr = gmtime( timep );
150 if ( tm_ptr == NULL ) {
156 LDAP_MUTEX_UNLOCK( &ldap_int_gmtime_mutex );
160 #endif /* !USE_GMTIME_R */
162 #ifndef USE_LOCALTIME_R
164 ldap_pvt_localtime( const time_t *timep, struct tm *result )
168 LDAP_MUTEX_LOCK( &ldap_int_gmtime_mutex );
169 tm_ptr = localtime( timep );
170 if ( tm_ptr == NULL ) {
176 LDAP_MUTEX_UNLOCK( &ldap_int_gmtime_mutex );
180 #endif /* !USE_LOCALTIME_R */
182 static int _ldap_pvt_gt_subs;
185 /* Windows SYSTEMTIME only has 10 millisecond resolution, so we
186 * also need to use a high resolution timer to get microseconds.
187 * This is pretty clunky.
189 static LARGE_INTEGER _ldap_pvt_gt_freq;
190 static LARGE_INTEGER _ldap_pvt_gt_prev;
191 static int _ldap_pvt_gt_offset;
193 #define SEC_TO_UNIX_EPOCH 11644473600LL
194 #define TICKS_PER_SECOND 10000000
197 ldap_pvt_gettimeusec(int *sec)
201 QueryPerformanceCounter( &count );
203 /* It shouldn't ever go backwards, but multiple CPUs might
204 * be able to hit in the same tick.
206 LDAP_MUTEX_LOCK( &ldap_int_gettime_mutex );
207 /* We assume Windows has at least a vague idea of
208 * when a second begins. So we align our microsecond count
209 * with the Windows millisecond count using this offset.
210 * We retain the submillisecond portion of our own count.
212 * Note - this also assumes that the relationship between
213 * the PerformanceCounter and SystemTime stays constant;
214 * that assumption breaks if the SystemTime is adjusted by
215 * an external action.
217 if ( !_ldap_pvt_gt_freq.QuadPart ) {
224 /* Initialize our offset */
225 QueryPerformanceFrequency( &_ldap_pvt_gt_freq );
227 /* Wait for a tick of the system time: 10-15ms */
228 GetSystemTimeAsFileTime( &ft0 );
230 GetSystemTimeAsFileTime( &ft1 );
231 } while ( ft1.dwLowDateTime == ft0.dwLowDateTime );
233 ut.LowPart = ft1.dwLowDateTime;
234 ut.HighPart = ft1.dwHighDateTime;
235 QueryPerformanceCounter( &c2 );
237 /* get second and fraction portion of counter */
238 t = c2.QuadPart % (_ldap_pvt_gt_freq.QuadPart*10);
240 /* convert to microseconds */
242 usec = t / _ldap_pvt_gt_freq.QuadPart;
245 ut.QuadPart %= 10000000;
246 _ldap_pvt_gt_offset = usec - ut.QuadPart;
249 if ( count.QuadPart <= _ldap_pvt_gt_prev.QuadPart ) {
252 _ldap_pvt_gt_subs = 0;
253 _ldap_pvt_gt_prev = count;
255 LDAP_MUTEX_UNLOCK( &ldap_int_gettime_mutex );
257 /* convert to microseconds */
258 count.QuadPart %= _ldap_pvt_gt_freq.QuadPart*10;
259 count.QuadPart *= 1000000;
260 count.QuadPart /= _ldap_pvt_gt_freq.QuadPart;
261 count.QuadPart -= _ldap_pvt_gt_offset;
263 /* We've extracted the 1s and microseconds.
264 * The 1sec digit is used to detect wraparound in microsecnds.
266 if (count.QuadPart < 0)
267 count.QuadPart += 10000000;
268 else if (count.QuadPart >= 10000000)
269 count.QuadPart -= 10000000;
271 *sec = count.QuadPart / 1000000;
272 return count.QuadPart % 1000000;
276 /* emulate POSIX gettimeofday */
278 ldap_pvt_gettimeofday( struct timeval *tv, void *unused )
284 GetSystemTimeAsFileTime( &ft );
285 ut.LowPart = ft.dwLowDateTime;
286 ut.HighPart = ft.dwHighDateTime;
288 /* convert to usec */
289 ut.QuadPart /= (TICKS_PER_SECOND / 1000000);
291 tv->tv_usec = ldap_pvt_gettimeusec(&sec);
292 tv->tv_sec = ut.QuadPart / 1000000 - SEC_TO_UNIX_EPOCH;
294 /* check for carry from microseconds */
295 sec0 = tv->tv_sec % 10;
296 if (sec0 < sec || (sec0 == 9 && !sec))
302 /* return a broken out time, with microseconds
305 ldap_pvt_gettime( struct lutil_tm *tm )
309 static const char daysPerMonth[] = {
310 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31};
312 GetSystemTime( &st );
313 tm->tm_usec = ldap_pvt_gettimeusec(&sec);
314 tm->tm_usub = _ldap_pvt_gt_subs;
316 /* any difference larger than microseconds is
317 * already reflected in st
319 tm->tm_sec = st.wSecond;
320 tm->tm_min = st.wMinute;
321 tm->tm_hour = st.wHour;
322 tm->tm_mday = st.wDay;
323 tm->tm_mon = st.wMonth - 1;
324 tm->tm_year = st.wYear - 1900;
326 /* check for carry from microseconds */
327 sec0 = tm->tm_sec % 10;
328 if (sec0 < sec || (sec0 == 9 && !sec)) {
330 /* FIXME: we don't handle leap seconds */
331 if (tm->tm_sec > 59) {
334 if (tm->tm_min > 59) {
337 if (tm->tm_hour > 23) {
338 int days = daysPerMonth[tm->tm_mon];
342 /* if it's February of a leap year,
343 * add 1 day to this month
345 if (tm->tm_mon == 1 &&
346 ((!(st.wYear % 4) && (st.wYear % 100)) ||
350 if (tm->tm_mday > days) {
353 if (tm->tm_mon > 11) {
365 static struct timeval _ldap_pvt_gt_prevTv;
368 ldap_pvt_gettime( struct lutil_tm *ltm )
375 gettimeofday( &tv, NULL );
378 LDAP_MUTEX_LOCK( &ldap_int_gettime_mutex );
379 if ( tv.tv_sec < _ldap_pvt_gt_prevTv.tv_sec
380 || ( tv.tv_sec == _ldap_pvt_gt_prevTv.tv_sec
381 && tv.tv_usec <= _ldap_pvt_gt_prevTv.tv_usec )) {
384 _ldap_pvt_gt_subs = 0;
385 _ldap_pvt_gt_prevTv = tv;
387 LDAP_MUTEX_UNLOCK( &ldap_int_gettime_mutex );
389 ltm->tm_usub = _ldap_pvt_gt_subs;
391 ldap_pvt_gmtime( &t, &tm );
393 ltm->tm_sec = tm.tm_sec;
394 ltm->tm_min = tm.tm_min;
395 ltm->tm_hour = tm.tm_hour;
396 ltm->tm_mday = tm.tm_mday;
397 ltm->tm_mon = tm.tm_mon;
398 ltm->tm_year = tm.tm_year;
399 ltm->tm_usec = tv.tv_usec;
404 ldap_pvt_csnstr(char *buf, size_t len, unsigned int replica, unsigned int mod)
409 ldap_pvt_gettime( &tm );
411 n = snprintf( buf, len,
412 "%4d%02d%02d%02d%02d%02d.%06dZ#%06x#%03x#%06x",
413 tm.tm_year + 1900, tm.tm_mon + 1, tm.tm_mday, tm.tm_hour,
414 tm.tm_min, tm.tm_sec, tm.tm_usec, tm.tm_usub, replica, mod );
416 if( n < 0 ) return 0;
417 return ( (size_t) n < len ) ? n : 0;
420 #define BUFSTART (1024-32)
421 #define BUFMAX (32*1024-32)
423 #if defined(LDAP_R_COMPILE)
424 static char *safe_realloc( char **buf, int len );
426 #if !(defined(HAVE_GETHOSTBYNAME_R) && defined(HAVE_GETHOSTBYADDR_R))
427 static int copy_hostent( struct hostent *res,
428 char **buf, struct hostent * src );
432 int ldap_pvt_gethostbyname_a(
434 struct hostent *resbuf,
436 struct hostent **result,
439 #if defined( HAVE_GETHOSTBYNAME_R )
441 # define NEED_SAFE_REALLOC 1
445 for(;buflen<BUFMAX;) {
446 if (safe_realloc( buf, buflen )==NULL)
449 #if (GETHOSTBYNAME_R_NARGS < 6)
450 *result=gethostbyname_r( name, resbuf, *buf, buflen, herrno_ptr );
451 r = (*result == NULL) ? -1 : 0;
453 r = gethostbyname_r( name, resbuf, *buf,
454 buflen, result, herrno_ptr );
457 Debug( LDAP_DEBUG_TRACE, "ldap_pvt_gethostbyname_a: host=%s, r=%d\n",
460 #ifdef NETDB_INTERNAL
462 (*herrno_ptr==NETDB_INTERNAL) &&
472 #elif defined( LDAP_R_COMPILE )
473 # define NEED_COPY_HOSTENT
478 LDAP_MUTEX_LOCK( &ldap_int_resolv_mutex );
480 he = gethostbyname( name );
483 *herrno_ptr = h_errno;
485 } else if (copy_hostent( resbuf, buf, he )<0) {
493 LDAP_MUTEX_UNLOCK( &ldap_int_resolv_mutex );
498 *result = gethostbyname( name );
504 *herrno_ptr = h_errno;
510 #if !defined( HAVE_GETNAMEINFO ) && !defined( HAVE_HSTRERROR )
512 hp_strerror( int err )
515 case HOST_NOT_FOUND: return _("Host not found (authoritative)");
516 case TRY_AGAIN: return _("Host not found (server fail?)");
517 case NO_RECOVERY: return _("Non-recoverable failure");
518 case NO_DATA: return _("No data of requested type");
519 #ifdef NETDB_INTERNAL
520 case NETDB_INTERNAL: return STRERROR( errno );
523 return _("Unknown resolver error");
527 int ldap_pvt_get_hname(
528 const struct sockaddr *sa,
535 #if defined( HAVE_GETNAMEINFO )
537 LDAP_MUTEX_LOCK( &ldap_int_resolv_mutex );
538 rc = getnameinfo( sa, len, name, namelen, NULL, 0, 0 );
539 LDAP_MUTEX_UNLOCK( &ldap_int_resolv_mutex );
540 if ( rc ) *err = (char *)AC_GAI_STRERROR( rc );
543 #else /* !HAVE_GETNAMEINFO */
546 struct hostent *hp = NULL;
547 #ifdef HAVE_GETHOSTBYADDR_R
549 int buflen=BUFSTART, h_errno;
554 if (sa->sa_family == AF_INET6) {
555 struct sockaddr_in6 *sin = (struct sockaddr_in6 *)sa;
556 addr = (char *)&sin->sin6_addr;
557 alen = sizeof(sin->sin6_addr);
560 if (sa->sa_family == AF_INET) {
561 struct sockaddr_in *sin = (struct sockaddr_in *)sa;
562 addr = (char *)&sin->sin_addr;
563 alen = sizeof(sin->sin_addr);
566 *err = (char *)HSTRERROR( rc );
569 #if defined( HAVE_GETHOSTBYADDR_R )
570 for(;buflen<BUFMAX;) {
571 if (safe_realloc( &buf, buflen )==NULL) {
572 *err = (char *)STRERROR( ENOMEM );
575 #if (GETHOSTBYADDR_R_NARGS < 8)
576 hp=gethostbyaddr_r( addr, alen, sa->sa_family,
577 &hb, buf, buflen, &h_errno );
578 rc = (hp == NULL) ? -1 : 0;
580 rc = gethostbyaddr_r( addr, alen, sa->sa_family,
584 #ifdef NETDB_INTERNAL
586 (h_errno==NETDB_INTERNAL) &&
596 strncpy( name, hp->h_name, namelen );
598 *err = (char *)HSTRERROR( h_errno );
601 #else /* HAVE_GETHOSTBYADDR_R */
603 LDAP_MUTEX_LOCK( &ldap_int_resolv_mutex );
604 hp = gethostbyaddr( addr, alen, sa->sa_family );
606 strncpy( name, hp->h_name, namelen );
610 *err = (char *)HSTRERROR( h_errno );
612 LDAP_MUTEX_UNLOCK( &ldap_int_resolv_mutex );
614 #endif /* !HAVE_GETHOSTBYADDR_R */
616 #endif /* !HAVE_GETNAMEINFO */
619 int ldap_pvt_gethostbyaddr_a(
623 struct hostent *resbuf,
625 struct hostent **result,
628 #if defined( HAVE_GETHOSTBYADDR_R )
630 # undef NEED_SAFE_REALLOC
631 # define NEED_SAFE_REALLOC
635 for(;buflen<BUFMAX;) {
636 if (safe_realloc( buf, buflen )==NULL)
638 #if (GETHOSTBYADDR_R_NARGS < 8)
639 *result=gethostbyaddr_r( addr, len, type,
640 resbuf, *buf, buflen, herrno_ptr );
641 r = (*result == NULL) ? -1 : 0;
643 r = gethostbyaddr_r( addr, len, type,
644 resbuf, *buf, buflen,
645 result, herrno_ptr );
648 #ifdef NETDB_INTERNAL
650 (*herrno_ptr==NETDB_INTERNAL) &&
660 #elif defined( LDAP_R_COMPILE )
661 # undef NEED_COPY_HOSTENT
662 # define NEED_COPY_HOSTENT
667 LDAP_MUTEX_LOCK( &ldap_int_resolv_mutex );
668 he = gethostbyaddr( addr, len, type );
671 *herrno_ptr = h_errno;
673 } else if (copy_hostent( resbuf, buf, he )<0) {
680 LDAP_MUTEX_UNLOCK( &ldap_int_resolv_mutex );
684 #else /* gethostbyaddr() */
686 *result = gethostbyaddr( addr, len, type );
695 * ldap_int_utils_init() should be called before any other function.
698 void ldap_int_utils_init( void )
705 #ifdef LDAP_R_COMPILE
706 #if !defined( USE_CTIME_R ) && !defined( HAVE_REENTRANT_FUNCTIONS )
707 ldap_pvt_thread_mutex_init( &ldap_int_ctime_mutex );
709 #if !defined( USE_GMTIME_R ) && !defined( USE_LOCALTIME_R )
710 ldap_pvt_thread_mutex_init( &ldap_int_gmtime_mutex );
712 ldap_pvt_thread_mutex_init( &ldap_int_resolv_mutex );
714 ldap_pvt_thread_mutex_init( &ldap_int_hostname_mutex );
716 ldap_pvt_thread_mutex_init( &ldap_int_gettime_mutex );
719 ldap_pvt_thread_mutex_init( &ldap_int_gssapi_mutex );
723 /* call other module init functions here... */
726 #if defined( NEED_COPY_HOSTENT )
727 # undef NEED_SAFE_REALLOC
728 #define NEED_SAFE_REALLOC
730 static char *cpy_aliases(
737 for( ; (*src) ; src++ ) {
738 len = strlen( *src ) + 1;
739 AC_MEMCPY( buf, *src, len );
747 static char *cpy_addresses(
754 for( ; (*src) ; src++ ) {
755 AC_MEMCPY( buf, *src, len );
763 static int copy_hostent(
766 struct hostent * src )
773 int total_alias_len=0;
775 int total_addr_len=0;
778 /* calculate the size needed for the buffer */
779 name_len = strlen( src->h_name ) + 1;
781 if( src->h_aliases != NULL ) {
782 for( p = src->h_aliases; (*p) != NULL; p++ ) {
783 total_alias_len += strlen( *p ) + 1;
788 if( src->h_addr_list != NULL ) {
789 for( p = src->h_addr_list; (*p) != NULL; p++ ) {
792 total_addr_len = n_addr * src->h_length;
795 total_len = (n_alias + n_addr + 2) * sizeof( char * ) +
796 total_addr_len + total_alias_len + name_len;
798 if (safe_realloc( buf, total_len )) {
800 tbuf = *buf + (n_alias + n_addr + 2) * sizeof( char * );
801 AC_MEMCPY( res, src, sizeof( struct hostent ) );
802 /* first the name... */
803 AC_MEMCPY( tbuf, src->h_name, name_len );
804 res->h_name = tbuf; tbuf+=name_len;
805 /* now the aliases */
807 if ( src->h_aliases != NULL ) {
808 tbuf = cpy_aliases( &tp, tbuf, src->h_aliases );
811 /* finally the addresses */
812 res->h_addr_list = tp;
813 if ( src->h_addr_list != NULL ) {
814 tbuf = cpy_addresses( &tp, tbuf, src->h_addr_list, src->h_length );
823 #if defined( NEED_SAFE_REALLOC )
824 static char *safe_realloc( char **buf, int len )
827 tmpbuf = LDAP_REALLOC( *buf, len );
835 char * ldap_pvt_get_fqdn( char *name )
838 char hostbuf[MAXHOSTNAMELEN+1];
839 struct hostent *hp, he_buf;
840 int rc, local_h_errno;
843 if( gethostname( hostbuf, MAXHOSTNAMELEN ) == 0 ) {
844 hostbuf[MAXHOSTNAMELEN] = '\0';
851 rc = ldap_pvt_gethostbyname_a( name,
852 &he_buf, &ha_buf, &hp, &local_h_errno );
854 if( rc < 0 || hp == NULL || hp->h_name == NULL ) {
855 fqdn = LDAP_STRDUP( name );
857 fqdn = LDAP_STRDUP( hp->h_name );
864 #if ( defined( HAVE_GETADDRINFO ) || defined( HAVE_GETNAMEINFO ) ) \
865 && !defined( HAVE_GAI_STRERROR )
866 char *ldap_pvt_gai_strerror (int code) {
871 #ifdef EAI_ADDRFAMILY
872 { EAI_ADDRFAMILY, N_("Address family for hostname not supported") },
874 { EAI_AGAIN, N_("Temporary failure in name resolution") },
875 { EAI_BADFLAGS, N_("Bad value for ai_flags") },
876 { EAI_FAIL, N_("Non-recoverable failure in name resolution") },
877 { EAI_FAMILY, N_("ai_family not supported") },
878 { EAI_MEMORY, N_("Memory allocation failure") },
880 { EAI_NODATA, N_("No address associated with hostname") },
882 { EAI_NONAME, N_("Name or service not known") },
883 { EAI_SERVICE, N_("Servname not supported for ai_socktype") },
884 { EAI_SOCKTYPE, N_("ai_socktype not supported") },
886 { EAI_SYSTEM, N_("System error") },
893 for ( i = 0; values[i].msg != NULL; i++ ) {
894 if ( values[i].code == code ) {
895 return (char *) _(values[i].msg);
899 return _("Unknown error");