1 /* os-ip.c -- platform-specific TCP & UDP related code */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2008 The OpenLDAP Foundation.
6 * Portions Copyright 1999 Lars Uffmann.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
17 /* Portions Copyright (c) 1995 Regents of the University of Michigan.
18 * All rights reserved.
20 /* Significant additional contributors include:
28 #include <ac/stdlib.h>
31 #include <ac/socket.h>
32 #include <ac/string.h>
34 #include <ac/unistd.h>
38 #endif /* HAVE_IO_H */
42 #if defined( HAVE_GETADDRINFO ) && defined( HAVE_INET_NTOP )
44 int ldap_int_inet4or6 = AF_UNSPEC;
46 int ldap_int_inet4or6 = AF_INET;
52 #define osip_debug(ld,fmt,arg1,arg2,arg3) \
54 ldap_log_printf(NULL, LDAP_DEBUG_TRACE, fmt, arg1, arg2, arg3); \
59 #define osip_debug(ld,fmt,arg1,arg2,arg3) ((void)0)
61 #endif /* LDAP_DEBUG */
64 ldap_pvt_set_errno(int err)
70 ldap_int_timeval_dup( struct timeval **dest, const struct timeval *src )
74 assert( dest != NULL );
81 new = (struct timeval *) LDAP_MALLOC(sizeof(struct timeval));
88 AC_MEMCPY( (char *) new, (const char *) src, sizeof(struct timeval));
95 ldap_pvt_ndelay_on(LDAP *ld, int fd)
97 osip_debug(ld, "ldap_ndelay_on: %d\n",fd,0,0);
98 return ber_pvt_socket_set_nonblock( fd, 1 );
102 ldap_pvt_ndelay_off(LDAP *ld, int fd)
104 osip_debug(ld, "ldap_ndelay_off: %d\n",fd,0,0);
105 return ber_pvt_socket_set_nonblock( fd, 0 );
109 ldap_int_socket(LDAP *ld, int family, int type )
111 ber_socket_t s = socket(family, type, 0);
112 osip_debug(ld, "ldap_new_socket: %d\n",s,0,0);
117 ldap_pvt_close_socket(LDAP *ld, int s)
119 osip_debug(ld, "ldap_close_socket: %d\n",s,0,0);
124 ldap_int_prepare_socket(LDAP *ld, int s, int proto )
126 osip_debug( ld, "ldap_prepare_socket: %d\n", s, 0, 0 );
128 #if defined( SO_KEEPALIVE ) || defined( TCP_NODELAY )
129 if ( proto == LDAP_PROTO_TCP ) {
132 if ( setsockopt( s, SOL_SOCKET, SO_KEEPALIVE,
133 (char*) &dummy, sizeof(dummy) ) == AC_SOCKET_ERROR )
135 osip_debug( ld, "ldap_prepare_socket: "
136 "setsockopt(%d, SO_KEEPALIVE) failed (ignored).\n",
139 #endif /* SO_KEEPALIVE */
141 if ( setsockopt( s, IPPROTO_TCP, TCP_NODELAY,
142 (char*) &dummy, sizeof(dummy) ) == AC_SOCKET_ERROR )
144 osip_debug( ld, "ldap_prepare_socket: "
145 "setsockopt(%d, TCP_NODELAY) failed (ignored).\n",
148 #endif /* TCP_NODELAY */
150 #endif /* SO_KEEPALIVE || TCP_NODELAY */
160 "ldap_is_socket_ready: error on socket %d: errno: %d (%s)\n", \
163 sock_errstr(errno) ); \
167 * check the socket for errors after select returned.
170 ldap_pvt_is_socket_ready(LDAP *ld, int s)
172 osip_debug(ld, "ldap_is_sock_ready: %d\n",s,0,0);
174 #if defined( notyet ) /* && defined( SO_ERROR ) */
177 ber_socklen_t dummy = sizeof(so_errno);
178 if ( getsockopt( s, SOL_SOCKET, SO_ERROR, &so_errno, &dummy )
184 ldap_pvt_set_errno(so_errno);
194 struct sockaddr_storage sin;
196 struct sockaddr_in sin;
199 ber_socklen_t dummy = sizeof(sin);
200 if ( getpeername( s, (struct sockaddr *) &sin, &dummy )
203 /* XXX: needs to be replace with ber_stream_read() */
215 #endif /* HAVE_WINSOCK */
217 /* NOTE: this is identical to analogous code in os-local.c */
222 struct timeval *tvp )
227 osip_debug(ld, "ldap_int_poll: fd: %d tm: %ld\n",
228 s, tvp ? tvp->tv_sec : -1L, 0);
233 int timeout = INFTIM;
236 fd.events = POLL_WRITE;
239 timeout = TV2MILLISEC( tvp );
243 rc = poll( &fd, 1, timeout );
245 } while ( rc == AC_SOCKET_ERROR && errno == EINTR &&
246 LDAP_BOOL_GET( &ld->ld_options, LDAP_BOOL_RESTART ) );
248 if ( rc == AC_SOCKET_ERROR ) {
252 if ( timeout == 0 && rc == 0 ) {
256 if ( fd.revents & POLL_WRITE ) {
257 if ( ldap_pvt_is_socket_ready( ld, s ) == -1 ) {
261 if ( ldap_pvt_ndelay_off( ld, s ) == -1 ) {
269 fd_set wfds, *z = NULL;
273 struct timeval tv = { 0 };
275 #if defined( FD_SETSIZE ) && !defined( HAVE_WINSOCK )
276 if ( s >= FD_SETSIZE ) {
277 rc = AC_SOCKET_ERROR;
279 ldap_pvt_set_errno( EMFILE );
297 rc = select( ldap_int_tblsize, z, &wfds,
304 } while ( rc == AC_SOCKET_ERROR && errno == EINTR &&
305 LDAP_BOOL_GET( &ld->ld_options, LDAP_BOOL_RESTART ) );
307 if ( rc == AC_SOCKET_ERROR ) {
311 if ( rc == 0 && tvp && tvp->tv_sec == 0 && tvp->tv_usec == 0 ) {
316 /* This means the connection failed */
317 if ( FD_ISSET(s, &efds) ) {
319 ber_socklen_t dummy = sizeof(so_errno);
320 if ( getsockopt( s, SOL_SOCKET, SO_ERROR,
321 (char *) &so_errno, &dummy ) == AC_SOCKET_ERROR || !so_errno )
324 so_errno = WSAGetLastError();
326 ldap_pvt_set_errno( so_errno );
327 osip_debug(ld, "ldap_int_poll: error on socket %d: "
328 "errno: %d (%s)\n", s, errno, sock_errstr( errno ));
332 if ( FD_ISSET(s, &wfds) ) {
334 if ( ldap_pvt_is_socket_ready( ld, s ) == -1 ) {
338 if ( ldap_pvt_ndelay_off(ld, s) == -1 ) {
346 osip_debug(ld, "ldap_int_poll: timed out\n",0,0,0);
347 ldap_pvt_set_errno( ETIMEDOUT );
352 ldap_pvt_connect(LDAP *ld, ber_socket_t s,
353 struct sockaddr *sin, ber_socklen_t addrlen,
357 struct timeval tv, *opt_tv = NULL;
359 #ifdef LDAP_CONNECTIONLESS
360 /* We could do a connect() but that would interfere with
361 * attempts to poll a broadcast address
363 if (LDAP_IS_UDP(ld)) {
364 if (ld->ld_options.ldo_peer)
365 ldap_memfree(ld->ld_options.ldo_peer);
366 ld->ld_options.ldo_peer=ldap_memalloc(sizeof(struct sockaddr));
367 AC_MEMCPY(ld->ld_options.ldo_peer,sin,sizeof(struct sockaddr));
371 if ( ld->ld_options.ldo_tm_net.tv_sec >= 0 ) {
372 tv = ld->ld_options.ldo_tm_net;
376 osip_debug(ld, "ldap_pvt_connect: fd: %d tm: %ld async: %d\n",
377 s, opt_tv ? tv.tv_sec : -1L, async);
379 if ( opt_tv && ldap_pvt_ndelay_on(ld, s) == -1 )
382 if ( connect(s, sin, addrlen) != AC_SOCKET_ERROR ) {
383 if ( opt_tv && ldap_pvt_ndelay_off(ld, s) == -1 )
389 if ( err != EINPROGRESS && err != EWOULDBLOCK ) {
394 /* caller will call ldap_int_poll() as appropriate? */
398 rc = ldap_int_poll( ld, s, opt_tv );
400 osip_debug(ld, "ldap_pvt_connect: %d\n", rc, 0, 0);
405 #ifndef HAVE_INET_ATON
407 ldap_pvt_inet_aton( const char *host, struct in_addr *in)
409 unsigned long u = inet_addr( host );
412 if ( u == INADDR_NONE ) return 0;
414 if ( u == 0xffffffffUL || u == (unsigned long) -1L ) return 0;
423 ldap_connect_to_host(LDAP *ld, Sockbuf *sb,
425 const char *host, int port,
430 ber_socket_t s = AC_SOCKET_INVALID;
432 #if defined( HAVE_GETADDRINFO ) && defined( HAVE_INET_NTOP )
435 struct addrinfo hints, *res, *sai;
439 struct hostent *hp = NULL;
440 struct hostent he_buf;
445 if( host == NULL ) host = "localhost";
448 case LDAP_PROTO_TCP: socktype = SOCK_STREAM;
450 "ldap_connect_to_host: TCP %s:%d\n",
453 case LDAP_PROTO_UDP: socktype = SOCK_DGRAM;
455 "ldap_connect_to_host: UDP %s:%d\n",
459 osip_debug( ld, "ldap_connect_to_host: unknown proto: %d\n",
464 #if defined( HAVE_GETADDRINFO ) && defined( HAVE_INET_NTOP )
465 memset( &hints, '\0', sizeof(hints) );
466 #ifdef USE_AI_ATTRCONFIG /* FIXME: configure test needed */
467 /* Use AI_ATTRCONFIG only on systems where its known to be needed. */
468 hints.ai_flags = AI_ATTRCONFIG;
470 hints.ai_family = ldap_int_inet4or6;
471 hints.ai_socktype = socktype;
472 snprintf(serv, sizeof serv, "%d", port );
474 #ifdef LDAP_R_COMPILE
475 /* most getaddrinfo(3) use non-threadsafe resolver libraries */
476 ldap_pvt_thread_mutex_lock(&ldap_int_resolv_mutex);
479 err = getaddrinfo( host, serv, &hints, &res );
481 #ifdef LDAP_R_COMPILE
482 ldap_pvt_thread_mutex_unlock(&ldap_int_resolv_mutex);
486 osip_debug(ld, "ldap_connect_to_host: getaddrinfo failed: %s\n",
487 AC_GAI_STRERROR(err), 0, 0);
492 for( sai=res; sai != NULL; sai=sai->ai_next) {
493 if( sai->ai_addr == NULL ) {
494 osip_debug(ld, "ldap_connect_to_host: getaddrinfo "
495 "ai_addr is NULL?\n", 0, 0, 0);
499 /* we assume AF_x and PF_x are equal for all x */
500 s = ldap_int_socket( ld, sai->ai_family, socktype );
501 if ( s == AC_SOCKET_INVALID ) {
505 if ( ldap_int_prepare_socket(ld, s, proto ) == -1 ) {
506 ldap_pvt_close_socket(ld, s);
510 switch (sai->ai_family) {
513 char addr[INET6_ADDRSTRLEN];
515 &((struct sockaddr_in6 *)sai->ai_addr)->sin6_addr,
517 osip_debug(ld, "ldap_connect_to_host: Trying %s %s\n",
522 char addr[INET_ADDRSTRLEN];
524 &((struct sockaddr_in *)sai->ai_addr)->sin_addr,
526 osip_debug(ld, "ldap_connect_to_host: Trying %s:%s\n",
531 rc = ldap_pvt_connect( ld, s,
532 sai->ai_addr, sai->ai_addrlen, async );
533 if ( rc == 0 || rc == -2 ) {
534 ber_sockbuf_ctrl( sb, LBER_SB_OPT_SET_FD, &s );
537 ldap_pvt_close_socket(ld, s);
542 if (! inet_aton( host, &in ) ) {
544 rc = ldap_pvt_gethostbyname_a( host, &he_buf, &ha_buf,
545 &hp, &local_h_errno );
547 if ( (rc < 0) || (hp == NULL) ) {
549 ldap_pvt_set_errno( WSAGetLastError() );
551 /* not exactly right, but... */
552 ldap_pvt_set_errno( EHOSTUNREACH );
554 if (ha_buf) LDAP_FREE(ha_buf);
562 for ( i = 0; !use_hp || (hp->h_addr_list[i] != 0); ++i, rc = -1 ) {
563 struct sockaddr_in sin;
565 s = ldap_int_socket( ld, PF_INET, socktype );
566 if ( s == AC_SOCKET_INVALID ) {
567 /* use_hp ? continue : break; */
571 if ( ldap_int_prepare_socket( ld, s, proto ) == -1 ) {
572 ldap_pvt_close_socket(ld, s);
576 (void)memset((char *)&sin, '\0', sizeof sin);
577 sin.sin_family = AF_INET;
578 sin.sin_port = htons((unsigned short) port);
581 AC_MEMCPY( &sin.sin_addr, hp->h_addr_list[i],
582 sizeof(sin.sin_addr) );
584 AC_MEMCPY( &sin.sin_addr, &in.s_addr,
585 sizeof(sin.sin_addr) );
588 #ifdef HAVE_INET_NTOA_B
591 char address[INET_ADDR_LEN];
592 inet_ntoa_b(sin.sin_address, address);
593 osip_debug(ld, "ldap_connect_to_host: Trying %s:%d\n",
597 osip_debug(ld, "ldap_connect_to_host: Trying %s:%d\n",
598 inet_ntoa(sin.sin_addr), port, 0);
601 rc = ldap_pvt_connect(ld, s,
602 (struct sockaddr *)&sin, sizeof(sin),
605 if ( (rc == 0) || (rc == -2) ) {
606 ber_sockbuf_ctrl( sb, LBER_SB_OPT_SET_FD, &s );
610 ldap_pvt_close_socket(ld, s);
614 if (ha_buf) LDAP_FREE(ha_buf);
620 #if defined( HAVE_CYRUS_SASL )
622 ldap_host_connected_to( Sockbuf *sb, const char *host )
626 struct sockaddr_storage sabuf;
628 struct sockaddr sabuf;
630 struct sockaddr *sa = (struct sockaddr *) &sabuf;
633 (void)memset( (char *)sa, '\0', sizeof sabuf );
636 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_FD, &sd );
637 if ( getpeername( sd, sa, &len ) == -1 ) {
642 * do a reverse lookup on the addr to get the official hostname.
643 * this is necessary for kerberos to work right, since the official
644 * hostname is used as the kerberos instance.
647 switch (sa->sa_family) {
650 return LDAP_STRDUP( ldap_int_hostname );
655 struct in6_addr localhost = IN6ADDR_LOOPBACK_INIT;
656 if( memcmp ( &((struct sockaddr_in6 *)sa)->sin6_addr,
657 &localhost, sizeof(localhost)) == 0 )
659 return LDAP_STRDUP( ldap_int_hostname );
666 struct in_addr localhost;
667 localhost.s_addr = htonl( INADDR_ANY );
669 if( memcmp ( &((struct sockaddr_in *)sa)->sin_addr,
670 &localhost, sizeof(localhost) ) == 0 )
672 return LDAP_STRDUP( ldap_int_hostname );
675 #ifdef INADDR_LOOPBACK
676 localhost.s_addr = htonl( INADDR_LOOPBACK );
678 if( memcmp ( &((struct sockaddr_in *)sa)->sin_addr,
679 &localhost, sizeof(localhost) ) == 0 )
681 return LDAP_STRDUP( ldap_int_hostname );
695 char hbuf[NI_MAXHOST];
696 #elif defined( MAXHOSTNAMELEN
697 char hbuf[MAXHOSTNAMELEN];
703 if (ldap_pvt_get_hname( sa, len, hbuf, sizeof(hbuf), &herr ) == 0
706 return LDAP_STRDUP( hbuf );
710 return host ? LDAP_STRDUP( host ) : NULL;
717 /* for UNIX poll(2) */
719 struct pollfd si_fds[FD_SETSIZE];
721 /* for UNIX select(2) */
724 fd_set si_use_readfds;
725 fd_set si_use_writefds;
730 ldap_mark_select_write( LDAP *ld, Sockbuf *sb )
732 struct selectinfo *sip;
735 sip = (struct selectinfo *)ld->ld_selectinfo;
737 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_FD, &sd );
740 /* for UNIX poll(2) */
744 for(i=0; i < sip->si_maxfd; i++) {
745 if( sip->si_fds[i].fd == sd ) {
746 sip->si_fds[i].events |= POLL_WRITE;
749 if( empty==-1 && sip->si_fds[i].fd == -1 ) {
755 if( sip->si_maxfd >= FD_SETSIZE ) {
759 empty = sip->si_maxfd++;
762 sip->si_fds[empty].fd = sd;
763 sip->si_fds[empty].events = POLL_WRITE;
766 /* for UNIX select(2) */
767 if ( !FD_ISSET( sd, &sip->si_writefds )) {
768 FD_SET( sd, &sip->si_writefds );
775 ldap_mark_select_read( LDAP *ld, Sockbuf *sb )
777 struct selectinfo *sip;
780 sip = (struct selectinfo *)ld->ld_selectinfo;
782 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_FD, &sd );
785 /* for UNIX poll(2) */
789 for(i=0; i < sip->si_maxfd; i++) {
790 if( sip->si_fds[i].fd == sd ) {
791 sip->si_fds[i].events |= POLL_READ;
794 if( empty==-1 && sip->si_fds[i].fd == -1 ) {
800 if( sip->si_maxfd >= FD_SETSIZE ) {
804 empty = sip->si_maxfd++;
807 sip->si_fds[empty].fd = sd;
808 sip->si_fds[empty].events = POLL_READ;
811 /* for UNIX select(2) */
812 if ( !FD_ISSET( sd, &sip->si_readfds )) {
813 FD_SET( sd, &sip->si_readfds );
820 ldap_mark_select_clear( LDAP *ld, Sockbuf *sb )
822 struct selectinfo *sip;
825 sip = (struct selectinfo *)ld->ld_selectinfo;
827 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_FD, &sd );
830 /* for UNIX poll(2) */
833 for(i=0; i < sip->si_maxfd; i++) {
834 if( sip->si_fds[i].fd == sd ) {
835 sip->si_fds[i].fd = -1;
840 /* for UNIX select(2) */
841 FD_CLR( sd, &sip->si_writefds );
842 FD_CLR( sd, &sip->si_readfds );
848 ldap_is_write_ready( LDAP *ld, Sockbuf *sb )
850 struct selectinfo *sip;
853 sip = (struct selectinfo *)ld->ld_selectinfo;
855 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_FD, &sd );
858 /* for UNIX poll(2) */
861 for(i=0; i < sip->si_maxfd; i++) {
862 if( sip->si_fds[i].fd == sd ) {
863 return sip->si_fds[i].revents & POLL_WRITE;
870 /* for UNIX select(2) */
871 return( FD_ISSET( sd, &sip->si_use_writefds ));
877 ldap_is_read_ready( LDAP *ld, Sockbuf *sb )
879 struct selectinfo *sip;
882 sip = (struct selectinfo *)ld->ld_selectinfo;
884 ber_sockbuf_ctrl( sb, LBER_SB_OPT_GET_FD, &sd );
887 /* for UNIX poll(2) */
890 for(i=0; i < sip->si_maxfd; i++) {
891 if( sip->si_fds[i].fd == sd ) {
892 return sip->si_fds[i].revents & POLL_READ;
899 /* for UNIX select(2) */
900 return( FD_ISSET( sd, &sip->si_use_readfds ));
906 ldap_new_select_info( void )
908 struct selectinfo *sip;
910 sip = (struct selectinfo *)LDAP_CALLOC( 1, sizeof( struct selectinfo ));
912 if ( sip == NULL ) return NULL;
915 /* for UNIX poll(2) */
916 /* sip->si_maxfd=0 */
918 /* for UNIX select(2) */
919 FD_ZERO( &sip->si_readfds );
920 FD_ZERO( &sip->si_writefds );
923 return( (void *)sip );
928 ldap_free_select_info( void *sip )
935 int ldap_int_tblsize = 0;
938 ldap_int_ip_init( void )
940 #if defined( HAVE_SYSCONF )
941 long tblsize = sysconf( _SC_OPEN_MAX );
942 if( tblsize > INT_MAX ) tblsize = INT_MAX;
944 #elif defined( HAVE_GETDTABLESIZE )
945 int tblsize = getdtablesize();
947 int tblsize = FD_SETSIZE;
948 #endif /* !USE_SYSCONF */
951 if( tblsize > FD_SETSIZE ) tblsize = FD_SETSIZE;
952 #endif /* FD_SETSIZE */
954 ldap_int_tblsize = tblsize;
960 ldap_int_select( LDAP *ld, struct timeval *timeout )
963 struct selectinfo *sip;
965 Debug( LDAP_DEBUG_TRACE, "ldap_int_select\n", 0, 0, 0 );
968 if ( ldap_int_tblsize == 0 ) ldap_int_ip_init();
971 sip = (struct selectinfo *)ld->ld_selectinfo;
972 assert( sip != NULL );
976 int to = timeout ? TV2MILLISEC( timeout ) : INFTIM;
977 rc = poll( sip->si_fds, sip->si_maxfd, to );
980 sip->si_use_readfds = sip->si_readfds;
981 sip->si_use_writefds = sip->si_writefds;
983 rc = select( ldap_int_tblsize,
984 &sip->si_use_readfds, &sip->si_use_writefds,