1 /* io.c - ber general i/o routines */
3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 * Copyright (c) 1990 Regents of the University of Michigan.
10 * Redistribution and use in source and binary forms are permitted
11 * provided that this notice is preserved and that due credit is given
12 * to the University of Michigan at Ann Arbor. The name of the University
13 * may not be used to endorse or promote products derived from this
14 * software without specific prior written permission. This software
15 * is provided ``as is'' without express or implied warranty.
22 #include <ac/stdlib.h>
26 #include <ac/socket.h>
27 #include <ac/string.h>
28 #include <ac/unistd.h>
35 #define LDAP_F_PRE LDAP_F_EXPORT
39 static long BerRead LDAP_P(( Sockbuf *sb, char *buf, long len ));
40 static int ber_realloc LDAP_P(( BerElement *ber, unsigned long len ));
44 /* probably far too large... */
45 #define MAX_BERBUFSIZE (128*1024)
47 #if defined( DOS ) && !defined( _WIN32 ) && (MAX_BERBUFSIZE > 65535)
48 # undef MAX_BERBUFSIZE
49 # define MAX_BERBUFSIZE 65535
53 BerRead( Sockbuf *sb, char *buf, long len )
59 assert( buf != NULL );
61 assert( SOCKBUF_VALID( sb ) );
64 if ( (c = ber_pvt_sb_read( sb, buf, len )) <= 0 ) {
78 ber_read( BerElement *ber, char *buf, unsigned long len )
80 unsigned long actuallen, nleft;
82 assert( ber != NULL );
83 assert( buf != NULL );
85 assert( BER_VALID( ber ) );
87 nleft = ber->ber_end - ber->ber_ptr;
88 actuallen = nleft < len ? nleft : len;
90 SAFEMEMCPY( buf, ber->ber_ptr, (size_t)actuallen );
92 ber->ber_ptr += actuallen;
94 return( (long)actuallen );
100 LDAP_CONST char *buf,
104 assert( ber != NULL );
105 assert( buf != NULL );
107 assert( BER_VALID( ber ) );
109 if ( nosos || ber->ber_sos == NULL ) {
110 if ( ber->ber_ptr + len > ber->ber_end ) {
111 if ( ber_realloc( ber, len ) != 0 )
114 SAFEMEMCPY( ber->ber_ptr, buf, (size_t)len );
118 if ( ber->ber_sos->sos_ptr + len > ber->ber_end ) {
119 if ( ber_realloc( ber, len ) != 0 )
122 SAFEMEMCPY( ber->ber_sos->sos_ptr, buf, (size_t)len );
123 ber->ber_sos->sos_ptr += len;
124 ber->ber_sos->sos_clen += len;
130 ber_realloc( BerElement *ber, unsigned long len )
132 unsigned long need, have, total;
137 assert( ber != NULL );
140 assert( BER_VALID( ber ) );
142 have = (ber->ber_end - ber->ber_buf) / EXBUFSIZ;
143 need = (len < EXBUFSIZ ? 1 : (len + (EXBUFSIZ - 1)) / EXBUFSIZ);
144 total = have * EXBUFSIZ + need * EXBUFSIZ;
146 oldbuf = ber->ber_buf;
148 ber->ber_buf = (char *) LBER_REALLOC( ber->ber_buf, total );
150 if ( ber->ber_buf == NULL ) {
151 ber->ber_buf = oldbuf;
155 ber->ber_end = ber->ber_buf + total;
158 * If the stinking thing was moved, we need to go through and
159 * reset all the sos and ber pointers. Offsets would've been
160 * a better idea... oh well.
163 if ( ber->ber_buf != oldbuf ) {
164 ber->ber_ptr = ber->ber_buf + (ber->ber_ptr - oldbuf);
166 for ( s = ber->ber_sos; s != NULLSEQORSET; s = s->sos_next ) {
167 off = s->sos_first - oldbuf;
168 s->sos_first = ber->ber_buf + off;
170 off = s->sos_ptr - oldbuf;
171 s->sos_ptr = ber->ber_buf + off;
179 ber_free( BerElement *ber, int freebuf )
181 #ifdef LDAP_MEMORY_DEBUG
182 assert( ber != NULL );
189 assert( BER_VALID( ber ) );
191 if ( freebuf && ber->ber_buf != NULL )
192 LBER_FREE( ber->ber_buf );
195 ber->ber_valid = LBER_UNINITIALIZED;
197 LBER_FREE( (char *) ber );
201 ber_flush( Sockbuf *sb, BerElement *ber, int freeit )
203 long nwritten, towrite, rc;
205 assert( sb != NULL );
206 assert( ber != NULL );
208 assert( SOCKBUF_VALID( ber ) );
209 assert( BER_VALID( ber ) );
211 if ( ber->ber_rwptr == NULL ) {
212 ber->ber_rwptr = ber->ber_buf;
214 towrite = ber->ber_ptr - ber->ber_rwptr;
216 if ( sb->sb_debug ) {
217 ber_log_printf( LDAP_DEBUG_ANY, sb->sb_debug,
218 "ber_flush: %ld bytes to sd %ld%s\n", towrite,
219 (long) sb->sb_sd, ber->ber_rwptr != ber->ber_buf ? " (re-flush)"
221 ber_log_bprint( LDAP_DEBUG_PACKETS, sb->sb_debug,
222 ber->ber_rwptr, towrite );
225 #if !defined(MACOS) && !defined(DOS)
226 if ( sb->sb_options & (LBER_TO_FILE | LBER_TO_FILE_ONLY) ) {
227 rc = write( sb->sb_fd, ber->ber_rwptr, towrite );
228 if ( sb->sb_options & LBER_TO_FILE_ONLY ) {
236 rc = ber_pvt_sb_write( sb, ber->ber_rwptr, towrite );
242 ber->ber_rwptr += rc;
243 } while ( towrite > 0 );
252 ber_alloc_t( int options )
256 ber_int_options.lbo_valid = LBER_INITIALIZED;
258 ber = (BerElement *) LBER_CALLOC( 1, sizeof(BerElement) );
260 if ( ber == NULLBER )
263 ber->ber_valid = LBER_VALID_BERELEMENT;
264 ber->ber_tag = LBER_DEFAULT;
265 ber->ber_options = options;
266 ber->ber_debug = ber_int_debug;
268 assert( BER_VALID( ber ) );
273 ber_alloc( void ) /* deprecated */
275 return( ber_alloc_t( 0 ) );
279 der_alloc( void ) /* deprecated */
281 return( ber_alloc_t( LBER_USE_DER ) );
285 ber_dup( LDAP_CONST BerElement *ber )
289 assert( ber != NULL );
290 assert( BER_VALID( ber ) );
292 if ( (new = ber_alloc_t( ber->ber_options )) == NULL ) {
298 assert( BER_VALID( new ) );
303 /* OLD U-Mich ber_init() */
305 ber_init_w_nullc( BerElement *ber, int options )
307 assert( ber != NULL );
309 ber_int_options.lbo_valid = LBER_INITIALIZED;
311 (void) memset( (char *)ber, '\0', sizeof( BerElement ));
312 ber->ber_valid = LBER_VALID_BERELEMENT;
313 ber->ber_tag = LBER_DEFAULT;
314 ber->ber_options = (char) options;
315 ber->ber_debug = ber_int_debug;
317 assert( BER_VALID( ber ) );
320 /* New C-API ber_init() */
321 /* This function constructs a BerElement containing a copy
322 ** of the data in the bv argument.
325 ber_init( struct berval *bv )
329 assert( bv != NULL );
331 ber_int_options.lbo_valid = LBER_INITIALIZED;
337 ber = ber_alloc_t( 0 );
339 if( ber == NULLBER ) {
340 /* allocation failed */
345 if ( ( (unsigned int) ber_write ( ber, bv->bv_val, bv->bv_len, 0 )) != bv->bv_len ) {
346 /* write failed, so free and return NULL */
351 ber_reset( ber, 1 ); /* reset the pointer to the start of the buffer */
356 /* New C-API ber_flatten routine */
357 /* This routine allocates a struct berval whose contents are a BER
358 ** encoding taken from the ber argument. The bvPtr pointer pointers to
359 ** the returned berval.
362 LDAP_CONST BerElement *ber,
363 struct berval **bvPtr)
367 assert( bvPtr != NULL );
369 ber_int_options.lbo_valid = LBER_INITIALIZED;
375 if ( (bv = LBER_MALLOC( sizeof(struct berval))) == NULL ) {
380 /* ber is null, create an empty berval */
385 /* copy the berval */
386 ptrdiff_t len = ber->ber_ptr - ber->ber_buf;
388 if ( (bv->bv_val = (char *) LBER_MALLOC( len + 1 )) == NULL ) {
393 SAFEMEMCPY( bv->bv_val, ber->ber_buf, (size_t)len );
394 bv->bv_val[len] = '\0';
403 ber_reset( BerElement *ber, int was_writing )
405 assert( ber != NULL );
406 assert( BER_VALID( ber ) );
409 ber->ber_end = ber->ber_ptr;
410 ber->ber_ptr = ber->ber_buf;
412 ber->ber_ptr = ber->ber_end;
415 ber->ber_rwptr = NULL;
419 /* return the tag - LBER_DEFAULT returned means trouble */
421 get_tag( Sockbuf *sb )
428 assert( sb != NULL );
429 assert( SOCKBUF_VALID( sb ) );
431 if ( ber_pvt_sb_read( sb, (char *) &xbyte, 1 ) != 1 )
432 return( LBER_DEFAULT );
434 if ( (xbyte & LBER_BIG_TAG_MASK) != LBER_BIG_TAG_MASK )
435 return( (unsigned long) xbyte );
437 tagp = (char *) &tag;
439 for ( i = 1; i < sizeof(long); i++ ) {
440 if ( ber_pvt_sb_read( sb, (char *) &xbyte, 1 ) != 1 )
441 return( LBER_DEFAULT );
445 if ( ! (xbyte & LBER_MORE_TAG_MASK) )
450 if ( i == sizeof(long) )
451 return( LBER_DEFAULT );
453 /* want leading, not trailing 0's */
454 return( tag >> (sizeof(long) - i - 1) );
459 * A rewrite of ber_get_next that can safely be called multiple times
460 * for the same packet. It will simply continue were it stopped until
461 * a full packet is read.
465 ber_get_next( Sockbuf *sb, unsigned long *len, BerElement *ber )
467 assert( sb != NULL );
468 assert( len != NULL );
469 assert( ber != NULL );
471 assert( SOCKBUF_VALID( sb ) );
472 assert( BER_VALID( ber ) );
474 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
478 * Any ber element looks like this: tag length contents.
479 * Assuming everything's ok, we return the tag byte (we
480 * can assume a single byte), return the length in len,
481 * and the rest of the undecoded element in buf.
484 * 1) small tags (less than 128)
485 * 2) definite lengths
486 * 3) primitive encodings used whenever possible
489 if (ber->ber_rwptr == NULL) {
491 * dtest does like this assert.
493 /* assert( ber->ber_buf == NULL ); */
494 ber->ber_rwptr = (char *) &ber->ber_tag;
498 #define PTR_IN_VAR( ptr, var )\
499 (((ptr)>=(char *) &(var)) && ((ptr)< (char *) &(var)+sizeof(var)))
501 if (PTR_IN_VAR(ber->ber_rwptr, ber->ber_tag)) {
502 if (ber->ber_rwptr == (char *) &ber->ber_tag) {
503 if (ber_pvt_sb_read( sb, ber->ber_rwptr, 1)<=0)
505 if ((ber->ber_rwptr[0] & LBER_BIG_TAG_MASK)
506 != LBER_BIG_TAG_MASK) {
507 ber->ber_tag = ber->ber_rwptr[0];
508 ber->ber_rwptr = (char *) &ber->ber_usertag;
514 /* reading the tag... */
515 if (ber_pvt_sb_read( sb, ber->ber_rwptr, 1)<=0)
517 if (! (ber->ber_rwptr[0] & LBER_MORE_TAG_MASK) ) {
518 ber->ber_tag>>=sizeof(ber->ber_tag) -
519 ((char *) &ber->ber_tag - ber->ber_rwptr);
520 ber->ber_rwptr = (char *) &ber->ber_usertag;
523 } while (PTR_IN_VAR(ber->ber_rwptr,ber->ber_tag));
524 errno = ERANGE; /* this is a serious error. */
528 if (ber->ber_rwptr==(char *) &ber->ber_usertag) {
530 if (ber_pvt_sb_read( sb, (char *) &c, 1)<=0)
534 if ( (len==0) || ((unsigned) len>sizeof( ber->ber_len ) ) ) {
538 ber->ber_rwptr = (char *) &ber->ber_len +
539 sizeof(ber->ber_len) - len;
546 if (PTR_IN_VAR(ber->ber_rwptr, ber->ber_len)) {
549 to_go = (char *) &ber->ber_len + sizeof( ber->ber_len ) -
552 res = ber_pvt_sb_read( sb, ber->ber_rwptr, to_go );
555 ber->ber_rwptr += res;
557 /* convert length. */
558 ber->ber_len = AC_NTOHL( ber->ber_len );
561 #if defined( EWOULDBLOCK )
563 #elif defined( EAGAIN )
570 /* now fill the buffer. */
571 if (ber->ber_buf==NULL) {
572 if (ber->ber_len > MAX_BERBUFSIZE) {
576 ber->ber_buf = (char *) LBER_MALLOC( ber->ber_len );
577 if (ber->ber_buf==NULL)
579 ber->ber_rwptr = ber->ber_buf;
580 ber->ber_ptr = ber->ber_buf;
581 ber->ber_end = ber->ber_buf + ber->ber_len;
583 if ((ber->ber_rwptr>=ber->ber_buf) && (ber->ber_rwptr<ber->ber_end)) {
587 to_go = ber->ber_end - ber->ber_rwptr;
590 res = ber_pvt_sb_read( sb, ber->ber_rwptr, to_go );
596 #if defined( EWOULDBLOCK )
598 #elif defined( EAGAIN )
604 ber->ber_rwptr = NULL;
606 if ( ber->ber_debug ) {
607 ber_log_printf( LDAP_DEBUG_TRACE, ber->ber_debug,
608 "ber_get_next: tag 0x%lx len %ld contents:\n",
609 ber->ber_tag, ber->ber_len );
610 ber_log_dump( LDAP_DEBUG_BER, ber->ber_debug, ber, 1 );
612 return (ber->ber_tag);
614 assert( 0 ); /* ber structure is messed up ?*/