1 /* sockbuf.c - i/o routines with support for adding i/o layers. */
4 * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
12 #include <ac/stdlib.h>
16 #include <ac/socket.h>
17 #include <ac/string.h>
18 #include <ac/unistd.h>
22 #endif /* HAVE_IO_H */
24 #if defined( HAVE_FCNTL_H )
28 #if defined( HAVE_SYS_FILIO_H )
29 #include <sys/filio.h>
30 #elif defined( HAVE_SYS_IOCTL_H )
31 #include <sys/ioctl.h>
36 #ifndef LBER_MIN_BUFF_SIZE
37 #define LBER_MIN_BUFF_SIZE 4096
39 #ifndef LBER_MAX_BUFF_SIZE
40 #define LBER_MAX_BUFF_SIZE 65536
42 #ifndef LBER_DEFAULT_READAHEAD
43 #define LBER_DEFAULT_READAHEAD 16384
47 ber_sockbuf_alloc( void )
51 ber_int_options.lbo_valid = LBER_INITIALIZED;
53 sb = LBER_CALLOC( 1, sizeof( Sockbuf ) );
55 if( sb == NULL ) return NULL;
57 ber_int_sb_init( sb );
62 ber_sockbuf_free( Sockbuf *sb )
65 assert( SOCKBUF_VALID( sb ) );
67 ber_int_sb_close( sb );
68 ber_int_sb_destroy( sb );
72 /* Return values: -1: error, 0: no operation performed or the answer is false,
73 * 1: successful operation or the answer is true
76 ber_sockbuf_ctrl( Sockbuf *sb, int opt, void *arg )
82 assert( SOCKBUF_VALID( sb ) );
85 case LBER_SB_OPT_HAS_IO:
87 while ( p && p->sbiod_io != (Sockbuf_IO *)arg ) {
96 case LBER_SB_OPT_GET_FD:
98 *((int *)arg) = sb->sb_fd;
100 ret = ( sb->sb_fd == AC_SOCKET_INVALID ? -1 : 1);
103 case LBER_SB_OPT_SET_FD:
104 sb->sb_fd = *((int *)arg);
108 case LBER_SB_OPT_SET_NONBLOCK:
109 ret = ber_pvt_socket_set_nonblock( sb->sb_fd, arg != NULL)
113 case LBER_SB_OPT_DRAIN: {
114 /* Drain the data source to enable possible errors (e.g.
115 * TLS) to be propagated to the upper layers
117 char buf[LBER_MIN_BUFF_SIZE];
120 ret = ber_int_sb_read( sb, buf, sizeof( buf ) );
121 } while ( ret == sizeof( buf ) );
126 case LBER_SB_OPT_NEEDS_READ:
127 ret = ( sb->sb_trans_needs_read ? 1 : 0 );
130 case LBER_SB_OPT_NEEDS_WRITE:
131 ret = ( sb->sb_trans_needs_write ? 1 : 0 );
134 case LBER_SB_OPT_GET_MAX_INCOMING:
136 *((ber_len_t *)arg) = sb->sb_max_incoming;
141 case LBER_SB_OPT_SET_MAX_INCOMING:
142 sb->sb_max_incoming = *((ber_len_t *)arg);
147 ret = sb->sb_iod->sbiod_io->sbi_ctrl( sb->sb_iod, opt, arg );
155 ber_sockbuf_add_io( Sockbuf *sb, Sockbuf_IO *sbio, int layer, void *arg )
157 Sockbuf_IO_Desc *d, *p, **q;
159 assert( sb != NULL );
160 assert( SOCKBUF_VALID( sb ) );
162 if ( sbio == NULL ) {
168 while ( p && p->sbiod_level > layer ) {
173 d = LBER_MALLOC( sizeof( *d ) );
178 d->sbiod_level = layer;
181 memset( &d->sbiod_pvt, '\0', sizeof( d->sbiod_pvt ) );
185 if ( sbio->sbi_setup != NULL && ( sbio->sbi_setup( d, arg ) < 0 ) ) {
193 ber_sockbuf_remove_io( Sockbuf *sb, Sockbuf_IO *sbio, int layer )
195 Sockbuf_IO_Desc *p, **q;
197 assert( sb != NULL );
198 assert( SOCKBUF_VALID( sb ) );
200 if ( sb->sb_iod == NULL ) {
205 while ( *q != NULL ) {
207 if ( layer == p->sbiod_level && p->sbiod_io == sbio ) {
208 if ( p->sbiod_io->sbi_remove != NULL &&
209 p->sbiod_io->sbi_remove( p ) < 0 )
224 ber_pvt_sb_buf_init( Sockbuf_Buf *buf )
226 buf->buf_base = NULL;
233 ber_pvt_sb_buf_destroy( Sockbuf_Buf *buf )
235 assert( buf != NULL);
238 LBER_FREE( buf->buf_base );
240 ber_pvt_sb_buf_init( buf );
244 ber_pvt_sb_grow_buffer( Sockbuf_Buf *buf, ber_len_t minsize )
249 assert( buf != NULL );
251 for ( pw = LBER_MIN_BUFF_SIZE; pw < minsize; pw <<= 1 ) {
252 if (pw > LBER_MAX_BUFF_SIZE) return -1;
255 if ( buf->buf_size < pw ) {
256 p = LBER_REALLOC( buf->buf_base, pw );
257 if ( p == NULL ) return -1;
265 ber_pvt_sb_copy_out( Sockbuf_Buf *sbb, char *buf, ber_len_t len )
269 assert( buf != NULL );
270 assert( sbb != NULL );
272 assert( sbb->buf_size > 0 );
275 max = sbb->buf_end - sbb->buf_ptr;
276 max = ( max < len) ? max : len;
278 AC_MEMCPY( buf, sbb->buf_base + sbb->buf_ptr, max );
280 if ( sbb->buf_ptr >= sbb->buf_end ) {
281 sbb->buf_ptr = sbb->buf_end = 0;
288 ber_pvt_sb_do_write( Sockbuf_IO_Desc *sbiod, Sockbuf_Buf *buf_out )
293 assert( sbiod != NULL );
294 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
296 to_go = buf_out->buf_end - buf_out->buf_ptr;
300 ret = LBER_SBIOD_WRITE_NEXT( sbiod, buf_out->buf_base +
301 buf_out->buf_ptr, to_go );
303 if ((ret<0) && (errno==EINTR)) continue;
308 if ( ret <= 0 ) return ret;
310 buf_out->buf_ptr += ret;
311 if (buf_out->buf_ptr == buf_out->buf_end) {
312 buf_out->buf_end = buf_out->buf_ptr = 0;
319 ber_pvt_socket_set_nonblock( ber_socket_t sd, int nb )
322 int flags = fcntl( sd, F_GETFL);
326 flags &= ~O_NONBLOCK;
328 return fcntl( sd, F_SETFL, flags );
330 #elif defined( FIONBIO )
331 ioctl_t status = nb ? 1 : 0;
332 return ioctl( sd, FIONBIO, &status );
337 ber_int_sb_init( Sockbuf *sb )
341 sb->sb_valid=LBER_VALID_SOCKBUF;
343 sb->sb_debug = ber_int_debug;
344 sb->sb_fd = AC_SOCKET_INVALID;
346 sb->sb_trans_needs_read = 0;
347 sb->sb_trans_needs_write = 0;
349 assert( SOCKBUF_VALID( sb ) );
354 ber_int_sb_close( Sockbuf *sb )
362 if ( p->sbiod_io->sbi_close && p->sbiod_io->sbi_close( p ) < 0 ) {
368 sb->sb_fd = AC_SOCKET_INVALID;
374 ber_int_sb_destroy( Sockbuf *sb )
379 assert( SOCKBUF_VALID( sb ) );
381 while ( sb->sb_iod ) {
382 p = sb->sb_iod->sbiod_next;
383 ber_sockbuf_remove_io( sb, sb->sb_iod->sbiod_io,
384 sb->sb_iod->sbiod_level );
388 return ber_int_sb_init( sb );
392 ber_int_sb_read( Sockbuf *sb, void *buf, ber_len_t len )
396 assert( buf != NULL );
398 assert( sb->sb_iod != NULL );
399 assert( SOCKBUF_VALID( sb ) );
402 ret = sb->sb_iod->sbiod_io->sbi_read( sb->sb_iod, buf, len );
405 if ( ( ret < 0 ) && ( errno == EINTR ) ) continue;
414 ber_int_sb_write( Sockbuf *sb, void *buf, ber_len_t len )
418 assert( buf != NULL );
420 assert( sb->sb_iod != NULL );
421 assert( SOCKBUF_VALID( sb ) );
424 ret = sb->sb_iod->sbiod_io->sbi_write( sb->sb_iod, buf, len );
427 if ( ( ret < 0 ) && ( errno == EINTR ) ) continue;
440 sb_stream_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
442 assert( sbiod != NULL);
443 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
447 * MacTCP/OpenTransport
449 return tcpread( sbiod->sbiod_sb->sb_fd, 0, (unsigned char *)buf,
452 #elif defined( HAVE_PCNFS ) || \
453 defined( HAVE_WINSOCK ) || defined ( __BEOS__ )
458 * Windows Socket API (under DOS/Windows 3.x)
461 * 32-bit Windows Socket API (under Windows NT or Windows 95)
466 rc = recv( sbiod->sbiod_sb->sb_fd, buf, len, 0 );
472 err = WSAGetLastError();
480 #elif defined( HAVE_NCSA )
482 * NCSA Telnet TCP/IP stack (under DOS)
484 return nread( sbiod->sbiod_sb->sb_fd, buf, len );
487 return read( sbiod->sbiod_sb->sb_fd, buf, len );
492 sb_stream_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
494 assert( sbiod != NULL);
495 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
499 * MacTCP/OpenTransport
501 #define MAX_WRITE 65535
502 return tcpwrite( sbiod->sbiod_sb->sb_fd, (unsigned char *)buf,
503 (len<MAX_WRITE) ? len : MAX_WRITE );
505 #elif defined( HAVE_PCNFS) \
506 || defined( HAVE_WINSOCK) || defined ( __BEOS__ )
511 * Windows Socket API (under DOS/Windows 3.x)
514 * 32-bit Windows Socket API (under Windows NT or Windows 95)
517 int rc = send( sbiod->sbiod_sb->sb_fd, buf, len, 0 );
522 err = WSAGetLastError();
529 #elif defined(HAVE_NCSA)
530 return netwrite( sbiod->sbiod_sb->sb_fd, buf, len );
534 * VMS -- each write must be 64K or smaller
536 #define MAX_WRITE 65535
537 return write( sbiod->sbiod_sb->sb_fd, buf,
538 (len<MAX_WRITE) ? len : MAX_WRITE);
540 return write( sbiod->sbiod_sb->sb_fd, buf, len );
545 sb_stream_close( Sockbuf_IO_Desc *sbiod )
547 assert( sbiod != NULL );
548 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
549 tcp_close( sbiod->sbiod_sb->sb_fd );
553 /* The argument is a pointer to the socket descriptor */
555 sb_stream_setup( Sockbuf_IO_Desc *sbiod, void *arg ) {
556 assert( sbiod != NULL );
559 sbiod->sbiod_sb->sb_fd = *((int *)arg);
565 sb_stream_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg ) {
566 /* This is an end IO descriptor */
570 Sockbuf_IO ber_sockbuf_io_tcp = {
571 sb_stream_setup, /* sbi_setup */
572 NULL, /* sbi_remove */
573 sb_stream_ctrl, /* sbi_ctrl */
574 sb_stream_read, /* sbi_read */
575 sb_stream_write, /* sbi_write */
576 sb_stream_close /* sbi_close */
581 * Support for readahead (UDP needs it)
585 sb_rdahead_setup( Sockbuf_IO_Desc *sbiod, void *arg )
589 assert( sbiod != NULL );
591 p = LBER_MALLOC( sizeof( *p ) );
592 if ( p == NULL ) return -1;
594 ber_pvt_sb_buf_init( p );
597 ber_pvt_sb_grow_buffer( p, LBER_DEFAULT_READAHEAD );
599 ber_pvt_sb_grow_buffer( p, *((int *)arg) );
602 sbiod->sbiod_pvt = p;
607 sb_rdahead_remove( Sockbuf_IO_Desc *sbiod )
611 assert( sbiod != NULL );
613 p = (Sockbuf_Buf *)sbiod->sbiod_pvt;
615 if ( p->buf_ptr != p->buf_end ) return -1;
617 ber_pvt_sb_buf_destroy( (Sockbuf_Buf *)(sbiod->sbiod_pvt) );
618 LBER_FREE( sbiod->sbiod_pvt );
619 sbiod->sbiod_pvt = NULL;
625 sb_rdahead_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
628 ber_slen_t bufptr = 0, ret, max;
630 assert( sbiod != NULL );
631 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
632 assert( sbiod->sbiod_next != NULL );
634 p = (Sockbuf_Buf *)sbiod->sbiod_pvt;
636 assert( p->buf_size > 0 );
638 /* Are there anything left in the buffer? */
639 ret = ber_pvt_sb_copy_out( p, buf, len );
643 if ( len == 0 ) return bufptr;
645 max = p->buf_size - p->buf_end;
648 ret = LBER_SBIOD_READ_NEXT( sbiod, p->buf_base + p->buf_end,
651 if ( ( ret < 0 ) && ( errno == EINTR ) ) continue;
657 return ( bufptr ? bufptr : ret );
661 bufptr += ber_pvt_sb_copy_out( p, (char *) buf + bufptr, len );
666 sb_rdahead_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
668 assert( sbiod != NULL );
669 assert( sbiod->sbiod_next != NULL );
671 return LBER_SBIOD_WRITE_NEXT( sbiod, buf, len );
675 sb_rdahead_close( Sockbuf_IO_Desc *sbiod )
677 assert( sbiod != NULL );
679 /* Just erase the buffer */
680 ber_pvt_sb_buf_destroy((Sockbuf_Buf *)sbiod->sbiod_pvt);
685 sb_rdahead_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
689 p = (Sockbuf_Buf *)sbiod->sbiod_pvt;
691 if ( opt == LBER_SB_OPT_DATA_READY ) {
692 if ( p->buf_ptr != p->buf_end ) {
696 } else if ( opt == LBER_SB_OPT_SET_READAHEAD ) {
697 if ( p->buf_size >= *((ber_len_t *)arg) ) {
700 return ( ber_pvt_sb_grow_buffer( p, *((int *)arg) ) ?
704 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
707 Sockbuf_IO ber_sockbuf_io_readahead = {
708 sb_rdahead_setup, /* sbi_setup */
709 sb_rdahead_remove, /* sbi_remove */
710 sb_rdahead_ctrl, /* sbi_ctrl */
711 sb_rdahead_read, /* sbi_read */
712 sb_rdahead_write, /* sbi_write */
713 sb_rdahead_close /* sbi_close */
717 * Support for simple file IO
721 sb_fd_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
723 assert( sbiod != NULL);
724 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
726 return read( sbiod->sbiod_sb->sb_fd, buf, len );
730 sb_fd_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
732 assert( sbiod != NULL);
733 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
735 return write( sbiod->sbiod_sb->sb_fd, buf, len );
739 sb_fd_close( Sockbuf_IO_Desc *sbiod )
741 assert( sbiod != NULL );
742 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
744 close( sbiod->sbiod_sb->sb_fd );
748 /* The argument is a pointer to the file descriptor */
750 sb_fd_setup( Sockbuf_IO_Desc *sbiod, void *arg ) {
751 assert( sbiod != NULL );
754 sbiod->sbiod_sb->sb_fd = *((int *)arg);
759 sb_fd_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg ) {
760 /* This is an end IO descriptor */
764 Sockbuf_IO ber_sockbuf_io_fd = {
765 sb_fd_setup, /* sbi_setup */
766 NULL, /* sbi_remove */
767 sb_fd_ctrl, /* sbi_ctrl */
768 sb_fd_read, /* sbi_read */
769 sb_fd_write, /* sbi_write */
770 sb_fd_close /* sbi_close */
778 sb_debug_setup( Sockbuf_IO_Desc *sbiod, void *arg )
780 assert( sbiod != NULL );
782 if ( arg == NULL ) arg = "sockbuf_";
784 sbiod->sbiod_pvt = LBER_MALLOC( strlen( arg ) + 1 );
785 if ( sbiod->sbiod_pvt == NULL ) return -1;
787 strcpy( (char *)sbiod->sbiod_pvt, (char *)arg );
792 sb_debug_remove( Sockbuf_IO_Desc *sbiod )
794 assert( sbiod != NULL );
795 assert( sbiod->sbiod_pvt != NULL );
797 LBER_FREE( sbiod->sbiod_pvt );
798 sbiod->sbiod_pvt = NULL;
803 sb_debug_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
805 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
809 sb_debug_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
813 ret = LBER_SBIOD_READ_NEXT( sbiod, buf, len );
814 if (sbiod->sbiod_sb->sb_debug & LDAP_DEBUG_PACKETS) {
817 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
818 "%sread: want=%ld error=%s\n", (char *)sbiod->sbiod_pvt,
819 (long)len, STRERROR( errno ) );
821 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
822 "%sread: want=%ld, got=%ld\n", (char *)sbiod->sbiod_pvt,
823 (long)len, (long)ret );
824 ber_log_bprint( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
825 (const char *)buf, ret );
833 sb_debug_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
837 ret = LBER_SBIOD_WRITE_NEXT( sbiod, buf, len );
838 if (sbiod->sbiod_sb->sb_debug & LDAP_DEBUG_PACKETS) {
841 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
842 "%swrite: want=%ld error=%s\n",
843 (char *)sbiod->sbiod_pvt, (long)len,
847 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
848 "%swrite: want=%ld, written=%ld\n",
849 (char *)sbiod->sbiod_pvt, (long)len, (long)ret );
850 ber_log_bprint( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
851 (const char *)buf, ret );
859 Sockbuf_IO ber_sockbuf_io_debug = {
860 sb_debug_setup, /* sbi_setup */
861 sb_debug_remove, /* sbi_remove */
862 sb_debug_ctrl, /* sbi_ctrl */
863 sb_debug_read, /* sbi_read */
864 sb_debug_write, /* sbi_write */
868 #ifdef LDAP_CONNECTIONLESS
871 * Support for UDP (CLDAP)
873 * All I/O at this level must be atomic. For ease of use, the sb_readahead
874 * must be used above this module. All data reads and writes are prefixed
875 * with a sockaddr containing the address of the remote entity. Upper levels
876 * must read and write this sockaddr before doing the usual ber_printf/scanf
877 * operations on LDAP messages.
881 sb_dgram_setup( Sockbuf_IO_Desc *sbiod, void *arg )
883 assert( sbiod != NULL);
884 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
886 if ( arg != NULL ) sbiod->sbiod_sb->sb_fd = *((int *)arg);
891 sb_dgram_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
895 struct sockaddr *src;
897 assert( sbiod != NULL );
898 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
899 assert( buf != NULL );
901 addrlen = sizeof( struct sockaddr );
904 rc = recvfrom( sbiod->sbiod_sb->sb_fd, buf, len, 0, src, &addrlen );
906 return rc > 0 ? rc+sizeof(struct sockaddr) : rc;
910 sb_dgram_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
913 struct sockaddr *dst;
915 assert( sbiod != NULL );
916 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
917 assert( buf != NULL );
920 buf += sizeof( struct sockaddr );
921 len -= sizeof( struct sockaddr );
923 rc = sendto( sbiod->sbiod_sb->sb_fd, buf, len, 0, dst,
924 sizeof( struct sockaddr ) );
926 if ( rc < 0 ) return -1;
928 /* fake error if write was not atomic */
935 rc = len + sizeof(struct sockaddr);
940 sb_dgram_close( Sockbuf_IO_Desc *sbiod )
942 assert( sbiod != NULL );
943 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
945 tcp_close( sbiod->sbiod_sb->sb_fd );
950 sb_dgram_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
952 /* This is an end IO descriptor */
956 Sockbuf_IO ber_sockbuf_io_udp =
958 sb_dgram_setup, /* sbi_setup */
959 NULL, /* sbi_remove */
960 sb_dgram_ctrl, /* sbi_ctrl */
961 sb_dgram_read, /* sbi_read */
962 sb_dgram_write, /* sbi_write */
963 sb_dgram_close /* sbi_close */
966 #endif /* LDAP_CONNECTIONLESS */