1 /* sockbuf.c - i/o routines with support for adding i/o layers. */
4 * Copyright 1998-2000 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 #define MIN_BUFF_SIZE 4096
37 #define MAX_BUFF_SIZE 65536
38 #define DEFAULT_READAHEAD 16384
41 ber_sockbuf_alloc( void )
45 ber_int_options.lbo_valid = LBER_INITIALIZED;
47 sb = LBER_CALLOC( 1, sizeof( Sockbuf ) );
49 if( sb == NULL ) return NULL;
51 ber_int_sb_init( sb );
56 ber_sockbuf_free( Sockbuf *sb )
59 assert( SOCKBUF_VALID( sb ) );
61 ber_int_sb_close( sb );
62 ber_int_sb_destroy( sb );
66 /* Return values: -1: error, 0: no operation performed or the answer is false,
67 * 1: successful operation or the answer is true
70 ber_sockbuf_ctrl( Sockbuf *sb, int opt, void *arg )
76 assert( SOCKBUF_VALID( sb ) );
79 case LBER_SB_OPT_HAS_IO:
81 while ( p && p->sbiod_io != (Sockbuf_IO *)arg ) {
90 case LBER_SB_OPT_GET_FD:
92 *((int *)arg) = sb->sb_fd;
94 ret = ( sb->sb_fd == AC_SOCKET_INVALID ? -1 : 1);
97 case LBER_SB_OPT_SET_FD:
98 sb->sb_fd = *((int *)arg);
102 case LBER_SB_OPT_SET_NONBLOCK:
103 ret = ber_pvt_socket_set_nonblock( sb->sb_fd, arg != NULL)
107 case LBER_SB_OPT_DRAIN: {
108 /* Drain the data source to enable possible errors (e.g.
109 * TLS) to be propagated to the upper layers
111 char buf[MIN_BUFF_SIZE];
114 ret = ber_int_sb_read( sb, buf, sizeof( buf ) );
115 } while ( ret == sizeof( buf ) );
120 case LBER_SB_OPT_NEEDS_READ:
121 ret = ( sb->sb_trans_needs_read ? 1 : 0 );
124 case LBER_SB_OPT_NEEDS_WRITE:
125 ret = ( sb->sb_trans_needs_write ? 1 : 0 );
128 case LBER_SB_OPT_GET_MAX_INCOMING:
130 *((ber_len_t *)arg) = sb->sb_max_incoming;
135 case LBER_SB_OPT_SET_MAX_INCOMING:
136 sb->sb_max_incoming = *((ber_len_t *)arg);
141 ret = sb->sb_iod->sbiod_io->sbi_ctrl( sb->sb_iod,
150 ber_sockbuf_add_io( Sockbuf *sb, Sockbuf_IO *sbio, int layer, void *arg )
152 Sockbuf_IO_Desc *d, *p, **q;
154 assert( sb != NULL );
155 assert( SOCKBUF_VALID( sb ) );
157 if ( sbio == NULL ) {
163 while ( p && p->sbiod_level > layer ) {
168 d = LBER_MALLOC( sizeof( *d ) );
173 d->sbiod_level = layer;
176 memset( &d->sbiod_pvt, '\0', sizeof( d->sbiod_pvt ) );
180 if ( sbio->sbi_setup != NULL && ( sbio->sbi_setup( d, arg ) < 0 ) ) {
188 ber_sockbuf_remove_io( Sockbuf *sb, Sockbuf_IO *sbio, int layer )
190 Sockbuf_IO_Desc *p, **q;
192 assert( sb != NULL );
193 assert( SOCKBUF_VALID( sb ) );
195 if ( sb->sb_iod == NULL ) {
200 while ( *q != NULL ) {
202 if ( layer == p->sbiod_level && p->sbiod_io == sbio ) {
203 if ( p->sbiod_io->sbi_remove != NULL &&
204 p->sbiod_io->sbi_remove( p ) < 0 )
219 ber_pvt_sb_buf_init( Sockbuf_Buf *buf )
221 buf->buf_base = NULL;
228 ber_pvt_sb_buf_destroy( Sockbuf_Buf *buf )
230 assert( buf != NULL);
233 LBER_FREE( buf->buf_base );
235 ber_pvt_sb_buf_init( buf );
239 ber_pvt_sb_grow_buffer( Sockbuf_Buf *buf, ber_len_t minsize )
244 assert( buf != NULL );
246 for ( pw = MIN_BUFF_SIZE; pw < minsize; pw <<= 1 ) {
247 if (pw > MAX_BUFF_SIZE)
251 if ( buf->buf_size < pw ) {
252 p = LBER_REALLOC( buf->buf_base, pw );
262 ber_pvt_sb_copy_out( Sockbuf_Buf *sbb, char *buf, ber_len_t len )
266 assert( buf != NULL );
267 assert( sbb != NULL );
269 assert( sbb->buf_size > 0 );
272 max = sbb->buf_end - sbb->buf_ptr;
273 max = ( max < len) ? max : len;
275 AC_MEMCPY( buf, sbb->buf_base + sbb->buf_ptr, max );
277 if ( sbb->buf_ptr >= sbb->buf_end ) {
278 sbb->buf_ptr = sbb->buf_end = 0;
285 ber_pvt_sb_do_write( Sockbuf_IO_Desc *sbiod, Sockbuf_Buf *buf_out )
290 assert( sbiod != NULL );
291 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
293 to_go = buf_out->buf_end - buf_out->buf_ptr;
297 ret = LBER_SBIOD_WRITE_NEXT( sbiod, buf_out->buf_base +
298 buf_out->buf_ptr, to_go );
300 if ((ret<0) && (errno==EINTR)) continue;
305 if ( ret <= 0 ) return ret;
307 buf_out->buf_ptr += ret;
308 if (buf_out->buf_ptr == buf_out->buf_end) {
309 buf_out->buf_end = buf_out->buf_ptr = 0;
312 if ( (ber_len_t)ret < to_go ) {
313 /* not enough data, so pretend no data was sent. */
321 ber_pvt_socket_set_nonblock( ber_socket_t sd, int nb )
324 int flags = fcntl( sd, F_GETFL);
328 flags &= ~O_NONBLOCK;
330 return fcntl( sd, F_SETFL, flags );
332 #elif defined( FIONBIO )
333 ioctl_t status = nb ? 1 : 0;
334 return ioctl( sd, FIONBIO, &status );
339 ber_int_sb_init( Sockbuf *sb )
343 sb->sb_valid=LBER_VALID_SOCKBUF;
345 sb->sb_debug = ber_int_debug;
346 sb->sb_fd = AC_SOCKET_INVALID;
348 sb->sb_trans_needs_read = 0;
349 sb->sb_trans_needs_write = 0;
351 assert( SOCKBUF_VALID( sb ) );
356 ber_int_sb_close( Sockbuf *sb )
364 if ( p->sbiod_io->sbi_close &&
365 p->sbiod_io->sbi_close( p ) < 0 )
372 sb->sb_fd = AC_SOCKET_INVALID;
378 ber_int_sb_destroy( Sockbuf *sb )
383 assert( SOCKBUF_VALID( sb ) );
385 while ( sb->sb_iod ) {
386 p = sb->sb_iod->sbiod_next;
387 ber_sockbuf_remove_io( sb, sb->sb_iod->sbiod_io,
388 sb->sb_iod->sbiod_level );
392 return ber_int_sb_init( sb );
396 ber_int_sb_read( Sockbuf *sb, void *buf, ber_len_t len )
400 assert( buf != NULL );
402 assert( sb->sb_iod != NULL );
403 assert( SOCKBUF_VALID( sb ) );
406 ret = sb->sb_iod->sbiod_io->sbi_read( sb->sb_iod, buf, len );
409 if ( ( ret < 0 ) && ( errno == EINTR ) ) continue;
418 ber_int_sb_write( Sockbuf *sb, void *buf, ber_len_t len )
422 assert( buf != NULL );
424 assert( sb->sb_iod != NULL );
425 assert( SOCKBUF_VALID( sb ) );
428 ret = sb->sb_iod->sbiod_io->sbi_write( sb->sb_iod, buf, len );
431 if ( ( ret < 0 ) && ( errno == EINTR ) ) continue;
444 sb_stream_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
446 assert( sbiod != NULL);
447 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
451 * MacTCP/OpenTransport
453 return tcpread( sbiod->sbiod_sb->sb_fd, 0, (unsigned char *)buf,
456 #elif defined( HAVE_PCNFS ) || \
457 defined( HAVE_WINSOCK ) || defined ( __BEOS__ )
462 * Windows Socket API (under DOS/Windows 3.x)
465 * 32-bit Windows Socket API (under Windows NT or Windows 95)
470 rc = recv( sbiod->sbiod_sb->sb_fd, buf, len, 0 );
476 err = WSAGetLastError();
484 #elif defined( HAVE_NCSA )
486 * NCSA Telnet TCP/IP stack (under DOS)
488 return nread( sbiod->sbiod_sb->sb_fd, buf, len );
491 return read( sbiod->sbiod_sb->sb_fd, buf, len );
496 sb_stream_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
498 assert( sbiod != NULL);
499 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
503 * MacTCP/OpenTransport
505 #define MAX_WRITE 65535
506 return tcpwrite( sbiod->sbiod_sb->sb_fd, (unsigned char *)buf,
507 (len<MAX_WRITE) ? len : MAX_WRITE );
509 #elif defined( HAVE_PCNFS) \
510 || defined( HAVE_WINSOCK) || defined ( __BEOS__ )
515 * Windows Socket API (under DOS/Windows 3.x)
518 * 32-bit Windows Socket API (under Windows NT or Windows 95)
521 int rc = send( sbiod->sbiod_sb->sb_fd, buf, len, 0 );
526 err = WSAGetLastError();
533 #elif defined(HAVE_NCSA)
534 return netwrite( sbiod->sbiod_sb->sb_fd, buf, len );
538 * VMS -- each write must be 64K or smaller
540 #define MAX_WRITE 65535
541 return write( sbiod->sbiod_sb->sb_fd, buf,
542 (len<MAX_WRITE) ? len : MAX_WRITE);
544 return write( sbiod->sbiod_sb->sb_fd, buf, len );
549 sb_stream_close( Sockbuf_IO_Desc *sbiod )
551 assert( sbiod != NULL );
552 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
553 tcp_close( sbiod->sbiod_sb->sb_fd );
557 /* The argument is a pointer to the socket descriptor */
559 sb_stream_setup( Sockbuf_IO_Desc *sbiod, void *arg ) {
560 assert( sbiod != NULL );
563 sbiod->sbiod_sb->sb_fd = *((int *)arg);
569 sb_stream_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg ) {
570 /* This is an end IO descriptor */
574 Sockbuf_IO ber_sockbuf_io_tcp = {
575 sb_stream_setup, /* sbi_setup */
576 NULL, /* sbi_remove */
577 sb_stream_ctrl, /* sbi_ctrl */
578 sb_stream_read, /* sbi_read */
579 sb_stream_write, /* sbi_write */
580 sb_stream_close /* sbi_close */
585 * Support for readahead (UDP needs it)
589 sb_rdahead_setup( Sockbuf_IO_Desc *sbiod, void *arg )
593 assert( sbiod != NULL );
595 p = LBER_MALLOC( sizeof( *p ) );
596 if ( p == NULL ) return -1;
598 ber_pvt_sb_buf_init( p );
601 ber_pvt_sb_grow_buffer( p, DEFAULT_READAHEAD );
603 ber_pvt_sb_grow_buffer( p, *((int *)arg) );
606 sbiod->sbiod_pvt = p;
611 sb_rdahead_remove( Sockbuf_IO_Desc *sbiod )
615 assert( sbiod != NULL );
617 p = (Sockbuf_Buf *)sbiod->sbiod_pvt;
619 if ( p->buf_ptr != p->buf_end ) return -1;
621 ber_pvt_sb_buf_destroy( (Sockbuf_Buf *)(sbiod->sbiod_pvt) );
622 LBER_FREE( sbiod->sbiod_pvt );
623 sbiod->sbiod_pvt = NULL;
629 sb_rdahead_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
632 ber_slen_t bufptr = 0, ret, max;
634 assert( sbiod != NULL );
635 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
636 assert( sbiod->sbiod_next != NULL );
638 p = (Sockbuf_Buf *)sbiod->sbiod_pvt;
640 assert( p->buf_size > 0 );
642 /* Are there anything left in the buffer? */
643 ret = ber_pvt_sb_copy_out( p, buf, len );
647 if ( len == 0 ) return bufptr;
649 max = p->buf_size - p->buf_end;
652 ret = LBER_SBIOD_READ_NEXT( sbiod, p->buf_base + p->buf_end,
655 if ( ( ret < 0 ) && ( errno == EINTR ) ) continue;
661 return ( bufptr ? bufptr : ret );
665 bufptr += ber_pvt_sb_copy_out( p, (char *) buf + bufptr, len );
670 sb_rdahead_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
672 assert( sbiod != NULL );
673 assert( sbiod->sbiod_next != NULL );
675 return LBER_SBIOD_WRITE_NEXT( sbiod, buf, len );
679 sb_rdahead_close( Sockbuf_IO_Desc *sbiod )
681 assert( sbiod != NULL );
683 /* Just erase the buffer */
684 ber_pvt_sb_buf_destroy((Sockbuf_Buf *)sbiod->sbiod_pvt);
689 sb_rdahead_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
693 p = (Sockbuf_Buf *)sbiod->sbiod_pvt;
695 if ( opt == LBER_SB_OPT_DATA_READY ) {
696 if ( p->buf_ptr != p->buf_end ) {
700 } else if ( opt == LBER_SB_OPT_SET_READAHEAD ) {
701 if ( p->buf_size >= *((ber_len_t *)arg) ) {
704 return ( ber_pvt_sb_grow_buffer( p, *((int *)arg) ) ?
708 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
711 Sockbuf_IO ber_sockbuf_io_readahead = {
712 sb_rdahead_setup, /* sbi_setup */
713 sb_rdahead_remove, /* sbi_remove */
714 sb_rdahead_ctrl, /* sbi_ctrl */
715 sb_rdahead_read, /* sbi_read */
716 sb_rdahead_write, /* sbi_write */
717 sb_rdahead_close /* sbi_close */
721 * Support for simple file IO
725 sb_fd_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
727 assert( sbiod != NULL);
728 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
730 return read( sbiod->sbiod_sb->sb_fd, buf, len );
734 sb_fd_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
736 assert( sbiod != NULL);
737 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
739 return write( sbiod->sbiod_sb->sb_fd, buf, len );
743 sb_fd_close( Sockbuf_IO_Desc *sbiod )
745 assert( sbiod != NULL );
746 assert( SOCKBUF_VALID( sbiod->sbiod_sb ) );
748 close( sbiod->sbiod_sb->sb_fd );
752 /* The argument is a pointer to the file descriptor */
754 sb_fd_setup( Sockbuf_IO_Desc *sbiod, void *arg ) {
755 assert( sbiod != NULL );
758 sbiod->sbiod_sb->sb_fd = *((int *)arg);
763 sb_fd_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg ) {
764 /* This is an end IO descriptor */
768 Sockbuf_IO ber_sockbuf_io_fd = {
769 sb_fd_setup, /* sbi_setup */
770 NULL, /* sbi_remove */
771 sb_fd_ctrl, /* sbi_ctrl */
772 sb_fd_read, /* sbi_read */
773 sb_fd_write, /* sbi_write */
774 sb_fd_close /* sbi_close */
782 sb_debug_setup( Sockbuf_IO_Desc *sbiod, void *arg )
784 assert( sbiod != NULL );
786 if ( arg == NULL ) arg = "sockbuf_";
788 sbiod->sbiod_pvt = LBER_MALLOC( strlen( arg ) + 1 );
789 if ( sbiod->sbiod_pvt == NULL ) return -1;
791 strcpy( (char *)sbiod->sbiod_pvt, (char *)arg );
796 sb_debug_remove( Sockbuf_IO_Desc *sbiod )
798 assert( sbiod != NULL );
799 assert( sbiod->sbiod_pvt != NULL );
801 LBER_FREE( sbiod->sbiod_pvt );
802 sbiod->sbiod_pvt = NULL;
807 sb_debug_ctrl( Sockbuf_IO_Desc *sbiod, int opt, void *arg )
809 return LBER_SBIOD_CTRL_NEXT( sbiod, opt, arg );
813 sb_debug_read( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
817 ret = LBER_SBIOD_READ_NEXT( sbiod, buf, len );
819 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
820 "%sread: want=%ld error=%s\n", (char *)sbiod->sbiod_pvt,
821 (long)len, STRERROR( errno ) );
824 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
825 "%sread: want=%ld, got=%ld\n", (char *)sbiod->sbiod_pvt,
826 (long)len, (long)ret );
827 ber_log_bprint( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
828 (const char *)buf, ret );
834 sb_debug_write( Sockbuf_IO_Desc *sbiod, void *buf, ber_len_t len )
838 ret = LBER_SBIOD_WRITE_NEXT( sbiod, buf, len );
840 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
841 "%swrite: want=%ld error=%s\n",
842 (char *)sbiod->sbiod_pvt, (long)len,
846 ber_log_printf( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
847 "%swrite: want=%ld, written=%ld\n",
848 (char *)sbiod->sbiod_pvt, (long)len, (long)ret );
849 ber_log_bprint( LDAP_DEBUG_PACKETS, sbiod->sbiod_sb->sb_debug,
850 (const char *)buf, ret );
856 Sockbuf_IO ber_sockbuf_io_debug = {
857 sb_debug_setup, /* sbi_setup */
858 sb_debug_remove, /* sbi_remove */
859 sb_debug_ctrl, /* sbi_ctrl */
860 sb_debug_read, /* sbi_read */
861 sb_debug_write, /* sbi_write */