1 /* sockbuf.c - i/o routines with support for adding i/o layers. */
4 * Copyright 1998-2002 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,
156 ber_sockbuf_add_io( Sockbuf *sb, Sockbuf_IO *sbio, int layer, void *arg )
158 Sockbuf_IO_Desc *d, *p, **q;
160 assert( sb != NULL );
161 assert( SOCKBUF_VALID( sb ) );
163 if ( sbio == NULL ) {
169 while ( p && p->sbiod_level > layer ) {
174 d = LBER_MALLOC( sizeof( *d ) );
179 d->sbiod_level = layer;
182 memset( &d->sbiod_pvt, '\0', sizeof( d->sbiod_pvt ) );
186 if ( sbio->sbi_setup != NULL && ( sbio->sbi_setup( d, arg ) < 0 ) ) {
194 ber_sockbuf_remove_io( Sockbuf *sb, Sockbuf_IO *sbio, int layer )
196 Sockbuf_IO_Desc *p, **q;
198 assert( sb != NULL );
199 assert( SOCKBUF_VALID( sb ) );
201 if ( sb->sb_iod == NULL ) {
206 while ( *q != NULL ) {
208 if ( layer == p->sbiod_level && p->sbiod_io == sbio ) {
209 if ( p->sbiod_io->sbi_remove != NULL &&
210 p->sbiod_io->sbi_remove( p ) < 0 )
225 ber_pvt_sb_buf_init( Sockbuf_Buf *buf )
227 buf->buf_base = NULL;
234 ber_pvt_sb_buf_destroy( Sockbuf_Buf *buf )
236 assert( buf != NULL);
239 LBER_FREE( buf->buf_base );
241 ber_pvt_sb_buf_init( buf );
245 ber_pvt_sb_grow_buffer( Sockbuf_Buf *buf, ber_len_t minsize )
250 assert( buf != NULL );
252 for ( pw = LBER_MIN_BUFF_SIZE; pw < minsize; pw <<= 1 ) {
253 if (pw > LBER_MAX_BUFF_SIZE) return -1;
256 if ( buf->buf_size < pw ) {
257 p = LBER_REALLOC( buf->buf_base, pw );
258 if ( p == NULL ) return -1;
266 ber_pvt_sb_copy_out( Sockbuf_Buf *sbb, char *buf, ber_len_t len )
270 assert( buf != NULL );
271 assert( sbb != NULL );
273 assert( sbb->buf_size > 0 );
276 max = sbb->buf_end - sbb->buf_ptr;
277 max = ( max < len) ? max : len;
279 AC_MEMCPY( buf, sbb->buf_base + sbb->buf_ptr, max );
281 if ( sbb->buf_ptr >= sbb->buf_end ) {
282 sbb->buf_ptr = sbb->buf_end = 0;
289 ber_pvt_sb_do_write( Sockbuf_IO_Desc *sbiod, Sockbuf_Buf *buf_out )
294 assert( sbiod != NULL );
295 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
297 to_go = buf_out->buf_end - buf_out->buf_ptr;
301 ret = LBER_SBIOD_WRITE_NEXT( sbiod, buf_out->buf_base +
302 buf_out->buf_ptr, to_go );
304 if ((ret<0) && (errno==EINTR)) continue;
309 if ( ret <= 0 ) return ret;
311 buf_out->buf_ptr += ret;
312 if (buf_out->buf_ptr == buf_out->buf_end) {
313 buf_out->buf_end = buf_out->buf_ptr = 0;
320 ber_pvt_socket_set_nonblock( ber_socket_t sd, int nb )
323 int flags = fcntl( sd, F_GETFL);
327 flags &= ~O_NONBLOCK;
329 return fcntl( sd, F_SETFL, flags );
331 #elif defined( FIONBIO )
332 ioctl_t status = nb ? 1 : 0;
333 return ioctl( sd, FIONBIO, &status );
338 ber_int_sb_init( Sockbuf *sb )
342 sb->sb_valid=LBER_VALID_SOCKBUF;
344 sb->sb_debug = ber_int_debug;
345 sb->sb_fd = AC_SOCKET_INVALID;
347 sb->sb_trans_needs_read = 0;
348 sb->sb_trans_needs_write = 0;
350 assert( SOCKBUF_VALID( sb ) );
355 ber_int_sb_close( Sockbuf *sb )
363 if ( p->sbiod_io->sbi_close &&
364 p->sbiod_io->sbi_close( p ) < 0 )
371 sb->sb_fd = AC_SOCKET_INVALID;
377 ber_int_sb_destroy( Sockbuf *sb )
382 assert( SOCKBUF_VALID( sb ) );
384 while ( sb->sb_iod ) {
385 p = sb->sb_iod->sbiod_next;
386 ber_sockbuf_remove_io( sb, sb->sb_iod->sbiod_io,
387 sb->sb_iod->sbiod_level );
391 return ber_int_sb_init( sb );
395 ber_int_sb_read( Sockbuf *sb, void *buf, ber_len_t len )
399 assert( buf != NULL );
401 assert( sb->sb_iod != NULL );
402 assert( SOCKBUF_VALID( sb ) );
405 ret = sb->sb_iod->sbiod_io->sbi_read( sb->sb_iod, buf, len );
408 if ( ( ret < 0 ) && ( errno == EINTR ) ) continue;
417 ber_int_sb_write( Sockbuf *sb, void *buf, ber_len_t len )
421 assert( buf != NULL );
423 assert( sb->sb_iod != NULL );
424 assert( SOCKBUF_VALID( sb ) );
427 ret = sb->sb_iod->sbiod_io->sbi_write( sb->sb_iod, buf, len );
430 if ( ( ret < 0 ) && ( errno == EINTR ) ) continue;
443 sb_stream_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
445 assert( sbiod != NULL);
446 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
450 * MacTCP/OpenTransport
452 return tcpread( sbiod->sbiod_sb->sb_fd, 0, (unsigned char *)buf,
455 #elif defined( HAVE_PCNFS ) || \
456 defined( HAVE_WINSOCK ) || defined ( __BEOS__ )
461 * Windows Socket API (under DOS/Windows 3.x)
464 * 32-bit Windows Socket API (under Windows NT or Windows 95)
469 rc = recv( sbiod->sbiod_sb->sb_fd, buf, len, 0 );
475 err = WSAGetLastError();
483 #elif defined( HAVE_NCSA )
485 * NCSA Telnet TCP/IP stack (under DOS)
487 return nread( sbiod->sbiod_sb->sb_fd, buf, len );
490 return read( sbiod->sbiod_sb->sb_fd, buf, len );
495 sb_stream_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
497 assert( sbiod != NULL);
498 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
502 * MacTCP/OpenTransport
504 #define MAX_WRITE 65535
505 return tcpwrite( sbiod->sbiod_sb->sb_fd, (unsigned char *)buf,
506 (len<MAX_WRITE) ? len : MAX_WRITE );
508 #elif defined( HAVE_PCNFS) \
509 || defined( HAVE_WINSOCK) || defined ( __BEOS__ )
514 * Windows Socket API (under DOS/Windows 3.x)
517 * 32-bit Windows Socket API (under Windows NT or Windows 95)
520 int rc = send( sbiod->sbiod_sb->sb_fd, buf, len, 0 );
525 err = WSAGetLastError();
532 #elif defined(HAVE_NCSA)
533 return netwrite( sbiod->sbiod_sb->sb_fd, buf, len );
537 * VMS -- each write must be 64K or smaller
539 #define MAX_WRITE 65535
540 return write( sbiod->sbiod_sb->sb_fd, buf,
541 (len<MAX_WRITE) ? len : MAX_WRITE);
543 return write( sbiod->sbiod_sb->sb_fd, buf, len );
548 sb_stream_close( Sockbuf_IO_Desc *sbiod )
550 assert( sbiod != NULL );
551 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
552 tcp_close( sbiod->sbiod_sb->sb_fd );
556 /* The argument is a pointer to the socket descriptor */
558 sb_stream_setup( Sockbuf_IO_Desc *sbiod, void *arg ) {
559 assert( sbiod != NULL );
562 sbiod->sbiod_sb->sb_fd = *((int *)arg);
568 sb_stream_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg ) {
569 /* This is an end IO descriptor */
573 Sockbuf_IO ber_sockbuf_io_tcp = {
574 sb_stream_setup, /* sbi_setup */
575 NULL, /* sbi_remove */
576 sb_stream_ctrl, /* sbi_ctrl */
577 sb_stream_read, /* sbi_read */
578 sb_stream_write, /* sbi_write */
579 sb_stream_close /* sbi_close */
584 * Support for readahead (UDP needs it)
588 sb_rdahead_setup( Sockbuf_IO_Desc *sbiod, void *arg )
592 assert( sbiod != NULL );
594 p = LBER_MALLOC( sizeof( *p ) );
595 if ( p == NULL ) return -1;
597 ber_pvt_sb_buf_init( p );
600 ber_pvt_sb_grow_buffer( p, LBER_DEFAULT_READAHEAD );
602 ber_pvt_sb_grow_buffer( p, *((int *)arg) );
605 sbiod->sbiod_pvt = p;
610 sb_rdahead_remove( Sockbuf_IO_Desc *sbiod )
614 assert( sbiod != NULL );
616 p = (Sockbuf_Buf *)sbiod->sbiod_pvt;
618 if ( p->buf_ptr != p->buf_end ) return -1;
620 ber_pvt_sb_buf_destroy( (Sockbuf_Buf *)(sbiod->sbiod_pvt) );
621 LBER_FREE( sbiod->sbiod_pvt );
622 sbiod->sbiod_pvt = NULL;
628 sb_rdahead_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
631 ber_slen_t bufptr = 0, ret, max;
633 assert( sbiod != NULL );
634 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
635 assert( sbiod->sbiod_next != NULL );
637 p = (Sockbuf_Buf *)sbiod->sbiod_pvt;
639 assert( p->buf_size > 0 );
641 /* Are there anything left in the buffer? */
642 ret = ber_pvt_sb_copy_out( p, buf, len );
646 if ( len == 0 ) return bufptr;
648 max = p->buf_size - p->buf_end;
651 ret = LBER_SBIOD_READ_NEXT( sbiod, p->buf_base + p->buf_end,
654 if ( ( ret < 0 ) && ( errno == EINTR ) ) continue;
660 return ( bufptr ? bufptr : ret );
664 bufptr += ber_pvt_sb_copy_out( p, (char *) buf + bufptr, len );
669 sb_rdahead_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
671 assert( sbiod != NULL );
672 assert( sbiod->sbiod_next != NULL );
674 return LBER_SBIOD_WRITE_NEXT( sbiod, buf, len );
678 sb_rdahead_close( Sockbuf_IO_Desc *sbiod )
680 assert( sbiod != NULL );
682 /* Just erase the buffer */
683 ber_pvt_sb_buf_destroy((Sockbuf_Buf *)sbiod->sbiod_pvt);
688 sb_rdahead_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
692 p = (Sockbuf_Buf *)sbiod->sbiod_pvt;
694 if ( opt == LBER_SB_OPT_DATA_READY ) {
695 if ( p->buf_ptr != p->buf_end ) {
699 } else if ( opt == LBER_SB_OPT_SET_READAHEAD ) {
700 if ( p->buf_size >= *((ber_len_t *)arg) ) {
703 return ( ber_pvt_sb_grow_buffer( p, *((int *)arg) ) ?
707 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
710 Sockbuf_IO ber_sockbuf_io_readahead = {
711 sb_rdahead_setup, /* sbi_setup */
712 sb_rdahead_remove, /* sbi_remove */
713 sb_rdahead_ctrl, /* sbi_ctrl */
714 sb_rdahead_read, /* sbi_read */
715 sb_rdahead_write, /* sbi_write */
716 sb_rdahead_close /* sbi_close */
720 * Support for simple file IO
724 sb_fd_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
726 assert( sbiod != NULL);
727 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
729 return read( sbiod->sbiod_sb->sb_fd, buf, len );
733 sb_fd_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
735 assert( sbiod != NULL);
736 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
738 return write( sbiod->sbiod_sb->sb_fd, buf, len );
742 sb_fd_close( Sockbuf_IO_Desc *sbiod )
744 assert( sbiod != NULL );
745 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
747 close( sbiod->sbiod_sb->sb_fd );
751 /* The argument is a pointer to the file descriptor */
753 sb_fd_setup( Sockbuf_IO_Desc *sbiod, void *arg ) {
754 assert( sbiod != NULL );
757 sbiod->sbiod_sb->sb_fd = *((int *)arg);
762 sb_fd_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg ) {
763 /* This is an end IO descriptor */
767 Sockbuf_IO ber_sockbuf_io_fd = {
768 sb_fd_setup, /* sbi_setup */
769 NULL, /* sbi_remove */
770 sb_fd_ctrl, /* sbi_ctrl */
771 sb_fd_read, /* sbi_read */
772 sb_fd_write, /* sbi_write */
773 sb_fd_close /* sbi_close */
781 sb_debug_setup( Sockbuf_IO_Desc *sbiod, void *arg )
783 assert( sbiod != NULL );
785 if ( arg == NULL ) arg = "sockbuf_";
787 sbiod->sbiod_pvt = LBER_MALLOC( strlen( arg ) + 1 );
788 if ( sbiod->sbiod_pvt == NULL ) return -1;
790 strcpy( (char *)sbiod->sbiod_pvt, (char *)arg );
795 sb_debug_remove( Sockbuf_IO_Desc *sbiod )
797 assert( sbiod != NULL );
798 assert( sbiod->sbiod_pvt != NULL );
800 LBER_FREE( sbiod->sbiod_pvt );
801 sbiod->sbiod_pvt = NULL;
806 sb_debug_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
808 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
812 sb_debug_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
816 ret = LBER_SBIOD_READ_NEXT( sbiod, buf, len );
817 if (sbiod->sbiod_sb->sb_debug & LDAP_DEBUG_PACKETS)
821 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
822 "%sread: want=%ld error=%s\n", (char *)sbiod->sbiod_pvt,
823 (long)len, STRERROR( errno ) );
825 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
826 "%sread: want=%ld, got=%ld\n", (char *)sbiod->sbiod_pvt,
827 (long)len, (long)ret );
828 ber_log_bprint( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
829 (const char *)buf, ret );
837 sb_debug_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
841 ret = LBER_SBIOD_WRITE_NEXT( sbiod, buf, len );
842 if (sbiod->sbiod_sb->sb_debug & LDAP_DEBUG_PACKETS)
846 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
847 "%swrite: want=%ld error=%s\n",
848 (char *)sbiod->sbiod_pvt, (long)len,
852 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
853 "%swrite: want=%ld, written=%ld\n",
854 (char *)sbiod->sbiod_pvt, (long)len, (long)ret );
855 ber_log_bprint( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
856 (const char *)buf, ret );
864 Sockbuf_IO ber_sockbuf_io_debug = {
865 sb_debug_setup, /* sbi_setup */
866 sb_debug_remove, /* sbi_remove */
867 sb_debug_ctrl, /* sbi_ctrl */
868 sb_debug_read, /* sbi_read */
869 sb_debug_write, /* sbi_write */
873 #ifdef LDAP_CONNECTIONLESS
876 * Support for UDP (CLDAP)
878 * All I/O at this level must be atomic. For ease of use, the sb_readahead
879 * must be used above this module. All data reads and writes are prefixed
880 * with a sockaddr containing the address of the remote entity. Upper levels
881 * must read and write this sockaddr before doing the usual ber_printf/scanf
882 * operations on LDAP messages.
886 sb_dgram_setup( Sockbuf_IO_Desc *sbiod, void *arg )
888 assert( sbiod != NULL);
889 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
892 sbiod->sbiod_sb->sb_fd = *((int *)arg);
897 sb_dgram_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
901 struct sockaddr *src;
903 assert( sbiod != NULL );
904 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
905 assert( buf != NULL );
907 addrlen = sizeof( struct sockaddr );
910 rc = recvfrom( sbiod->sbiod_sb->sb_fd, buf, len, 0, src,
913 return rc > 0 ? rc+sizeof(struct sockaddr) : rc;
917 sb_dgram_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
920 struct sockaddr *dst;
922 assert( sbiod != NULL );
923 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
924 assert( buf != NULL );
927 buf += sizeof( struct sockaddr );
928 len -= sizeof( struct sockaddr );
930 rc = sendto( sbiod->sbiod_sb->sb_fd, buf, len, 0, dst,
931 sizeof( struct sockaddr ) );
936 /* fake error if write was not atomic */
943 rc = len + sizeof(struct sockaddr);
948 sb_dgram_close( Sockbuf_IO_Desc *sbiod )
950 assert( sbiod != NULL );
951 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
953 tcp_close( sbiod->sbiod_sb->sb_fd );
958 sb_dgram_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
960 /* This is an end IO descriptor */
964 Sockbuf_IO ber_sockbuf_io_udp =
966 sb_dgram_setup, /* sbi_setup */
967 NULL, /* sbi_remove */
968 sb_dgram_ctrl, /* sbi_ctrl */
969 sb_dgram_read, /* sbi_read */
970 sb_dgram_write, /* sbi_write */
971 sb_dgram_close /* sbi_close */
974 #endif /* LDAP_CONNECTIONLESS */