2 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
3 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
6 * Copyright (c) 1990 Regents of the University of Michigan.
9 * result.c - wait for an ldap result
18 #include <ac/socket.h>
19 #include <ac/string.h>
21 #include <ac/unistd.h>
26 static int ldap_abandoned LDAP_P(( LDAP *ld, int msgid ));
27 static int ldap_mark_abandoned LDAP_P(( LDAP *ld, int msgid ));
28 static int wait4msg LDAP_P(( LDAP *ld, int msgid, int all, struct timeval *timeout,
29 LDAPMessage **result ));
30 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
31 static int read1msg LDAP_P(( LDAP *ld, int msgid, int all, Sockbuf *sb, LDAPConn *lc,
32 LDAPMessage **result ));
33 static unsigned long build_result_ber LDAP_P(( LDAP *ld, BerElement *ber, LDAPRequest *lr ));
34 static void merge_error_info LDAP_P(( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr ));
35 #else /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
36 static int read1msg LDAP_P(( LDAP *ld, int msgid, int all, Sockbuf *sb,
37 LDAPMessage **result ));
38 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
39 #if defined( LDAP_CONNECTIONLESS ) || !defined( LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS )
40 static int ldap_select1 LDAP_P(( LDAP *ld, struct timeval *timeout ));
45 * ldap_result - wait for an ldap result response to a message from the
46 * ldap server. If msgid is -1, any message will be accepted, otherwise
47 * ldap_result will wait for a response with msgid. If all is 0 the
48 * first message with id msgid will be accepted, otherwise, ldap_result
49 * will wait for all responses with id msgid and then return a pointer to
50 * the entire list of messages. This is only useful for search responses,
51 * which can be of two message types (zero or more entries, followed by an
52 * ldap result). The type of the first message received is returned.
53 * When waiting, any messages that have been abandoned are discarded.
56 * ldap_result( s, msgid, all, timeout, result )
59 ldap_result( LDAP *ld, int msgid, int all, struct timeval *timeout,
60 LDAPMessage **result )
62 LDAPMessage *lm, *lastlm, *nextlm;
65 * First, look through the list of responses we have received on
66 * this association and see if the response we're interested in
67 * is there. If it is, return it. If not, call wait4msg() to
68 * wait until it arrives or timeout occurs.
71 Debug( LDAP_DEBUG_TRACE, "ldap_result\n", 0, 0, 0 );
75 for ( lm = ld->ld_responses; lm != NULLMSG; lm = nextlm ) {
78 if ( ldap_abandoned( ld, lm->lm_msgid ) ) {
79 ldap_mark_abandoned( ld, lm->lm_msgid );
81 if ( lastlm == NULLMSG ) {
82 ld->ld_responses = lm->lm_next;
84 lastlm->lm_next = nextlm;
92 if ( msgid == LDAP_RES_ANY || lm->lm_msgid == msgid ) {
96 || (lm->lm_msgtype != LDAP_RES_SEARCH_RESULT
97 && lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE /* LDAPv3 */
98 && lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY) )
101 for ( tmp = lm; tmp != NULLMSG; tmp = tmp->lm_chain ) {
102 if ( tmp->lm_msgtype == LDAP_RES_SEARCH_RESULT )
106 if ( tmp == NULLMSG ) {
107 return( wait4msg( ld, msgid, all, timeout,
115 if ( lm == NULLMSG ) {
116 return( wait4msg( ld, msgid, all, timeout, result ) );
119 if ( lastlm == NULLMSG ) {
120 ld->ld_responses = (all == 0 && lm->lm_chain != NULLMSG
121 ? lm->lm_chain : lm->lm_next);
123 lastlm->lm_next = (all == 0 && lm->lm_chain != NULLMSG
124 ? lm->lm_chain : lm->lm_next);
127 lm->lm_chain = NULLMSG;
128 lm->lm_next = NULLMSG;
131 ld->ld_errno = LDAP_SUCCESS;
132 return( lm->lm_msgtype );
136 wait4msg( LDAP *ld, int msgid, int all, struct timeval *timeout,
137 LDAPMessage **result )
140 struct timeval tv, *tvp;
141 time_t start_time = 0;
143 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
144 LDAPConn *lc, *nextlc;
145 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
148 if ( timeout == NULL ) {
149 Debug( LDAP_DEBUG_TRACE, "wait4msg (infinite timeout)\n",
152 Debug( LDAP_DEBUG_TRACE, "wait4msg (timeout %ld sec, %ld usec)\n",
153 (long) timeout->tv_sec, (long) timeout->tv_usec, 0 );
155 #endif /* LDAP_DEBUG */
157 if ( timeout == NULL ) {
162 start_time = time( NULL );
167 #ifndef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
169 if ( ld->ld_sb.sb_ber.ber_ptr >= ld->ld_sb.sb_ber.ber_end ) {
170 rc = ldap_select1( ld, tvp );
172 if ( rc == 0 || ( rc == -1 && (
173 ( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
175 || errno != EINTR ))) {
176 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
183 rc = -2; /* select interrupted: loop */
185 rc = read1msg( ld, msgid, all, &ld->ld_sb, result );
187 #else /* !LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
189 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
190 ldap_dump_connection( ld, ld->ld_conns, 1 );
191 ldap_dump_requests_and_responses( ld );
193 #endif /* LDAP_DEBUG */
194 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
195 if ( lc->lconn_sb->sb_ber.ber_ptr <
196 lc->lconn_sb->sb_ber.ber_end ) {
197 rc = read1msg( ld, msgid, all, lc->lconn_sb,
204 rc = do_ldap_select( ld, tvp );
209 Debug( LDAP_DEBUG_TRACE,
210 "do_ldap_select returned -1: errno %d\n",
215 if ( rc == 0 || ( rc == -1 && (
216 ( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
218 || errno != EINTR )))
220 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
226 rc = -2; /* select interrupted: loop */
229 for ( lc = ld->ld_conns; rc == -2 && lc != NULL;
231 nextlc = lc->lconn_next;
232 if ( lc->lconn_status ==
233 LDAP_CONNST_CONNECTED &&
234 ldap_is_read_ready( ld,
236 rc = read1msg( ld, msgid, all,
237 lc->lconn_sb, lc, result );
242 #endif /* !LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
244 if ( rc == -2 && tvp != NULL ) {
245 tmp_time = time( NULL );
246 if (( tv.tv_sec -= ( tmp_time - start_time )) <= 0 ) {
247 rc = 0; /* timed out */
248 ld->ld_errno = LDAP_TIMEOUT;
252 Debug( LDAP_DEBUG_TRACE, "wait4msg: %ld secs to go\n",
253 (long) tv.tv_sec, 0, 0 );
254 start_time = tmp_time;
263 read1msg( LDAP *ld, int msgid, int all, Sockbuf *sb,
264 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
266 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
267 LDAPMessage **result )
270 LDAPMessage *new, *l, *prev, *tmp;
272 unsigned long tag, len;
274 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
277 int rc, refer_cnt, hadref, simple_request;
279 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
281 Debug( LDAP_DEBUG_TRACE, "read1msg\n", 0, 0, 0 );
283 ber_init_w_nullc( &ber, 0 );
284 ldap_set_ber_options( ld, &ber );
286 /* get the next message */
287 if ( (tag = ber_get_next( sb, &len, &ber ))
288 != LDAP_TAG_MESSAGE ) {
289 ld->ld_errno = (tag == LBER_DEFAULT ? LDAP_SERVER_DOWN :
295 if ( ber_get_int( &ber, &id ) == LBER_ERROR ) {
296 ld->ld_errno = LDAP_DECODING_ERROR;
300 /* if it's been abandoned, toss it */
301 if ( ldap_abandoned( ld, (int)id ) ) {
302 free( ber.ber_buf ); /* gack! */
303 return( -2 ); /* continue looking */
306 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
307 if (( lr = ldap_find_request_by_msgid( ld, id )) == NULL ) {
308 Debug( LDAP_DEBUG_ANY,
309 "no request for response with msgid %ld (tossing)\n",
311 free( ber.ber_buf ); /* gack! */
312 return( -2 ); /* continue looking */
314 Debug( LDAP_DEBUG_TRACE, "got %s msgid %ld, original id %d\n",
315 ( tag == LDAP_RES_SEARCH_ENTRY ) ? "entry" : "result", id,
318 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
320 /* the message type */
321 if ( (tag = ber_peek_tag( &ber, &len )) == LBER_ERROR ) {
322 ld->ld_errno = LDAP_DECODING_ERROR;
326 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
328 hadref = simple_request = 0;
329 rc = -2; /* default is to keep looking (no response found) */
330 lr->lr_res_msgtype = tag;
332 if ( tag != LDAP_RES_SEARCH_ENTRY ) {
333 if ( ld->ld_version >= LDAP_VERSION2 &&
334 ( lr->lr_parent != NULL ||
335 ( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
336 != LDAP_OPT_OFF ) ) )
338 tmpber = ber; /* struct copy */
339 if ( ber_scanf( &tmpber, "{iaa}", &lderr,
340 &lr->lr_res_matched, &lr->lr_res_error )
342 if ( lderr != LDAP_SUCCESS ) {
343 /* referrals are in error string */
344 refer_cnt = ldap_chase_referrals( ld, lr,
345 &lr->lr_res_error, &hadref );
348 /* save errno, message, and matched string */
349 if ( !hadref || lr->lr_res_error == NULL ) {
350 lr->lr_res_errno = ( lderr ==
351 LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
353 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
354 lr->lr_res_errno = ld->ld_errno;
356 lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
358 Debug( LDAP_DEBUG_TRACE,
359 "new result: res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
360 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
361 lr->lr_res_matched ? lr->lr_res_matched : "" );
365 Debug( LDAP_DEBUG_TRACE,
366 "read1msg: %d new referrals\n", refer_cnt, 0, 0 );
368 if ( refer_cnt != 0 ) { /* chasing referrals */
369 free( ber.ber_buf ); /* gack! */
371 if ( refer_cnt < 0 ) {
372 return( -1 ); /* fatal error */
374 lr->lr_status = LDAP_REQST_CHASINGREFS;
376 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
377 /* request without any referrals */
378 simple_request = ( hadref ? 0 : 1 );
380 /* request with referrals or child request */
381 free( ber.ber_buf ); /* gack! */
385 while ( lr->lr_parent != NULL ) {
386 merge_error_info( ld, lr->lr_parent, lr );
389 if ( --lr->lr_outrefcnt > 0 ) {
390 break; /* not completely done yet */
394 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
396 tag = lr->lr_res_msgtype;
397 Debug( LDAP_DEBUG_ANY, "request %ld done\n",
399 Debug( LDAP_DEBUG_TRACE,
400 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
401 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
402 lr->lr_res_matched ? lr->lr_res_matched : "" );
403 if ( !simple_request ) {
404 if ( ber.ber_buf != NULL ) {
405 free( ber.ber_buf ); /* gack! */
408 if ( build_result_ber( ld, &ber, lr )
410 ld->ld_errno = LDAP_NO_MEMORY;
411 rc = -1; /* fatal error */
415 ldap_free_request( ld, lr );
419 ldap_free_connection( ld, lc, 0, 1 );
424 if ( ber.ber_buf == NULL ) {
428 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
429 /* make a new ldap message */
430 if ( (new = (LDAPMessage *) calloc( 1, sizeof(LDAPMessage) ))
432 ld->ld_errno = LDAP_NO_MEMORY;
435 new->lm_msgid = (int)id;
436 new->lm_msgtype = tag;
437 new->lm_ber = ber_dup( &ber );
440 if ( ld->ld_cache != NULL ) {
441 ldap_add_result_to_cache( ld, new );
443 #endif /* LDAP_NOCACHE */
445 /* is this the one we're looking for? */
446 if ( msgid == LDAP_RES_ANY || id == msgid ) {
448 || (new->lm_msgtype != LDAP_RES_SEARCH_RESULT
449 && new->lm_msgtype != LDAP_RES_SEARCH_ENTRY) ) {
451 ld->ld_errno = LDAP_SUCCESS;
453 } else if ( new->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
454 foundit = 1; /* return the chain later */
459 * if not, we must add it to the list of responses. if
460 * the msgid is already there, it must be part of an existing
465 for ( l = ld->ld_responses; l != NULLMSG; l = l->lm_next ) {
466 if ( l->lm_msgid == new->lm_msgid )
471 /* not part of an existing search response */
472 if ( l == NULLMSG ) {
475 ld->ld_errno = LDAP_SUCCESS;
479 new->lm_next = ld->ld_responses;
480 ld->ld_responses = new;
481 return( -2 ); /* continue looking */
484 Debug( LDAP_DEBUG_TRACE, "adding response id %d type %d:\n",
485 new->lm_msgid, new->lm_msgtype, 0 );
487 /* part of a search response - add to end of list of entries */
488 for ( tmp = l; tmp->lm_chain != NULLMSG &&
489 tmp->lm_chain->lm_msgtype == LDAP_RES_SEARCH_ENTRY;
490 tmp = tmp->lm_chain )
494 /* return the whole chain if that's what we were looking for */
496 if ( prev == NULLMSG )
497 ld->ld_responses = l->lm_next;
499 prev->lm_next = l->lm_next;
501 ld->ld_errno = LDAP_SUCCESS;
502 #ifdef LDAP_WORLD_P16
504 * XXX questionable fix; see text for [P16] on
505 * http://www.critical-angle.com/ldapworld/patch/
507 * inclusion of this patch causes searchs to hang on
510 return( l->lm_msgtype );
511 #else /* LDAP_WORLD_P16 */
513 #endif /* !LDAP_WORLD_P16 */
516 return( -2 ); /* continue looking */
520 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
522 build_result_ber( LDAP *ld, BerElement *ber, LDAPRequest *lr )
527 ber_init_w_nullc( ber, 0 );
528 ldap_set_ber_options( ld, ber );
529 if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
530 (long)lr->lr_res_msgtype, lr->lr_res_errno,
531 lr->lr_res_matched ? lr->lr_res_matched : "",
532 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 ) {
533 return( LBER_ERROR );
537 if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
538 return( LBER_ERROR );
541 if ( ber_get_int( ber, &along ) == LBER_ERROR ) {
542 return( LBER_ERROR );
545 return( ber_peek_tag( ber, &len ));
550 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
553 * Merge error information in "lr" with "parentr" error code and string.
555 if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
556 parentr->lr_res_errno = lr->lr_res_errno;
557 if ( lr->lr_res_error != NULL ) {
558 (void)ldap_append_referral( ld, &parentr->lr_res_error,
561 } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
562 parentr->lr_res_errno == LDAP_SUCCESS ) {
563 parentr->lr_res_errno = lr->lr_res_errno;
564 if ( parentr->lr_res_error != NULL ) {
565 free( parentr->lr_res_error );
567 parentr->lr_res_error = lr->lr_res_error;
568 lr->lr_res_error = NULL;
569 if ( NAME_ERROR( lr->lr_res_errno )) {
570 if ( parentr->lr_res_matched != NULL ) {
571 free( parentr->lr_res_matched );
573 parentr->lr_res_matched = lr->lr_res_matched;
574 lr->lr_res_matched = NULL;
578 Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info: ",
579 parentr->lr_msgid, 0, 0 );
580 Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
581 parentr->lr_res_errno, parentr->lr_res_error ?
582 parentr->lr_res_error : "", parentr->lr_res_matched ?
583 parentr->lr_res_matched : "" );
585 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
589 #if defined( LDAP_CONNECTIONLESS ) || !defined( LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS )
592 ldap_select1( LDAP *ld, struct timeval *timeout )
597 if ( tblsize == 0 ) {
599 tblsize = sysconf( _SC_OPEN_MAX );
600 #elif HAVE_GETDTABLESIZE
601 tblsize = getdtablesize();
603 tblsize = FD_SETSIZE;
606 if ( tblsize > FD_SETSIZE ) {
607 tblsize = FD_SETSIZE;
609 #endif /* FD_SETSIZE */
613 FD_SET( ld->ld_sb.sb_sd, &readfds );
615 return( select( tblsize, &readfds, 0, 0, timeout ) );
618 #endif /* !LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
622 ldap_msgtype( LDAPMessage *lm )
624 return( lm ? lm->lm_msgtype : -1 );
628 ldap_msgid( LDAPMessage *lm )
630 return( lm ? lm->lm_msgid : -1 );
635 ldap_msgfree( LDAPMessage *lm )
640 Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
642 for ( ; lm != NULLMSG; lm = next ) {
644 type = lm->lm_msgtype;
645 ber_free( lm->lm_ber, 1 );
653 * ldap_msgdelete - delete a message. It returns:
654 * 0 if the entire message was deleted
655 * -1 if the message was not found, or only part of it was found
658 ldap_msgdelete( LDAP *ld, int msgid )
660 LDAPMessage *lm, *prev;
662 Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
665 for ( lm = ld->ld_responses; lm != NULLMSG; lm = lm->lm_next ) {
666 if ( lm->lm_msgid == msgid )
674 if ( prev == NULLMSG )
675 ld->ld_responses = lm->lm_next;
677 prev->lm_next = lm->lm_next;
679 if ( ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
687 * return 1 if message msgid is waiting to be abandoned, 0 otherwise
690 ldap_abandoned( LDAP *ld, int msgid )
694 if ( ld->ld_abandoned == NULL )
697 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
698 if ( ld->ld_abandoned[i] == msgid )
706 ldap_mark_abandoned( LDAP *ld, int msgid )
710 if ( ld->ld_abandoned == NULL )
713 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
714 if ( ld->ld_abandoned[i] == msgid )
717 if ( ld->ld_abandoned[i] == -1 )
720 for ( ; ld->ld_abandoned[i] != -1; i++ ) {
721 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];
728 #ifdef LDAP_CONNECTIONLESS
730 cldap_getmsg( LDAP *ld, struct timeval *timeout, BerElement *ber )
733 unsigned long tag, len;
735 if ( ld->ld_sb.sb_ber.ber_ptr >= ld->ld_sb.sb_ber.ber_end ) {
736 rc = ldap_select1( ld, timeout );
737 if ( rc == -1 || rc == 0 ) {
738 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
744 /* get the next message */
745 if ( (tag = ber_get_next( &ld->ld_sb, &len, ber ))
746 != LDAP_TAG_MESSAGE ) {
747 ld->ld_errno = (tag == LBER_DEFAULT ? LDAP_SERVER_DOWN :
754 #endif /* LDAP_CONNECTIONLESS */