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 try_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 try_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 ( ! ber_pvt_sb_data_ready(&ld->ld_sb) ) {
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 = try_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 ( ber_pvt_sb_data_ready(lc->lconn_sb) ) {
196 rc = try_read1msg( ld, msgid, all, lc->lconn_sb,
203 rc = do_ldap_select( ld, tvp );
208 Debug( LDAP_DEBUG_TRACE,
209 "do_ldap_select returned -1: errno %d\n",
214 if ( rc == 0 || ( rc == -1 && (
215 ( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
217 || errno != EINTR )))
219 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
225 rc = -2; /* select interrupted: loop */
228 for ( lc = ld->ld_conns; rc == -2 && lc != NULL;
230 nextlc = lc->lconn_next;
231 if ( lc->lconn_status ==
232 LDAP_CONNST_CONNECTED &&
233 ldap_is_read_ready( ld,
235 rc = try_read1msg( ld, msgid, all,
236 lc->lconn_sb, lc, result );
241 #endif /* !LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
243 if ( rc == -2 && tvp != NULL ) {
244 tmp_time = time( NULL );
245 if (( tv.tv_sec -= ( tmp_time - start_time )) <= 0 ) {
246 rc = 0; /* timed out */
247 ld->ld_errno = LDAP_TIMEOUT;
251 Debug( LDAP_DEBUG_TRACE, "wait4msg: %ld secs to go\n",
252 (long) tv.tv_sec, 0, 0 );
253 start_time = tmp_time;
262 try_read1msg( LDAP *ld, int msgid, int all, Sockbuf *sb,
263 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
265 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
266 LDAPMessage **result )
269 LDAPMessage *new, *l, *prev, *tmp;
271 unsigned long tag, len;
273 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
276 int rc, refer_cnt, hadref, simple_request;
279 ber = &lc->lconn_ber;
282 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
284 Debug( LDAP_DEBUG_TRACE, "read1msg\n", 0, 0, 0 );
286 ber_init_w_nullc( &ber, 0 );
287 ldap_set_ber_options( ld, &ber );
289 /* get the next message */
290 if ( (tag = ber_get_next( sb, &len, ber ))
291 != LDAP_TAG_MESSAGE ) {
292 if ( tag == LBER_DEFAULT) {
294 Debug( LDAP_DEBUG_CONNS,
295 "ber_get_next failed.\n", 0, 0, 0 );
298 if (errno==EWOULDBLOCK) return -2;
301 if (errno == EAGAIN) return -2;
303 ld->ld_errno = LDAP_SERVER_DOWN;
306 ld->ld_errno = LDAP_LOCAL_ERROR;
311 if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
312 ld->ld_errno = LDAP_DECODING_ERROR;
316 /* if it's been abandoned, toss it */
317 if ( ldap_abandoned( ld, (int)id ) ) {
318 ber_clear( ber, 1 ); /* gack! */
319 return( -2 ); /* continue looking */
322 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
323 if (( lr = ldap_find_request_by_msgid( ld, id )) == NULL ) {
324 Debug( LDAP_DEBUG_ANY,
325 "no request for response with msgid %ld (tossing)\n",
327 ber_clear( ber, 1 ); /* gack! */
328 return( -2 ); /* continue looking */
330 Debug( LDAP_DEBUG_TRACE, "ldap_read: %s msgid %ld, original id %d\n",
331 ( tag == LDAP_RES_SEARCH_ENTRY ) ? "entry" :
332 ( tag == LDAP_RES_SEARCH_REFERENCE ) ? "reference" : "result",
335 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
337 /* the message type */
338 if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
339 ld->ld_errno = LDAP_DECODING_ERROR;
343 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
345 hadref = simple_request = 0;
346 rc = -2; /* default is to keep looking (no response found) */
347 lr->lr_res_msgtype = tag;
349 if ( tag != LDAP_RES_SEARCH_ENTRY ) {
350 if ( ld->ld_version >= LDAP_VERSION2 &&
351 ( lr->lr_parent != NULL ||
352 ( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
353 != LDAP_OPT_OFF ) ) )
355 tmpber = *ber; /* struct copy */
356 if ( ber_scanf( &tmpber, "{iaa}", &lderr,
357 &lr->lr_res_matched, &lr->lr_res_error )
359 if ( lderr != LDAP_SUCCESS ) {
360 /* referrals are in error string */
361 refer_cnt = ldap_chase_referrals( ld, lr,
362 &lr->lr_res_error, &hadref );
365 /* save errno, message, and matched string */
366 if ( !hadref || lr->lr_res_error == NULL ) {
367 lr->lr_res_errno = ( lderr ==
368 LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
370 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
371 lr->lr_res_errno = ld->ld_errno;
373 lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
375 Debug( LDAP_DEBUG_TRACE,
376 "new result: res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
377 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
378 lr->lr_res_matched ? lr->lr_res_matched : "" );
382 Debug( LDAP_DEBUG_TRACE,
383 "read1msg: %d new referrals\n", refer_cnt, 0, 0 );
385 if ( refer_cnt != 0 ) { /* chasing referrals */
386 ber_clear( ber, 1 ); /* gack! */
387 if ( refer_cnt < 0 ) {
388 return( -1 ); /* fatal error */
390 lr->lr_status = LDAP_REQST_CHASINGREFS;
392 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
393 /* request without any referrals */
394 simple_request = ( hadref ? 0 : 1 );
396 /* request with referrals or child request */
397 ber_clear( ber, 1 ); /* gack! */
400 while ( lr->lr_parent != NULL ) {
401 merge_error_info( ld, lr->lr_parent, lr );
404 if ( --lr->lr_outrefcnt > 0 ) {
405 break; /* not completely done yet */
409 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
411 tag = lr->lr_res_msgtype;
412 Debug( LDAP_DEBUG_ANY, "request %ld done\n",
414 Debug( LDAP_DEBUG_TRACE,
415 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
416 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
417 lr->lr_res_matched ? lr->lr_res_matched : "" );
418 if ( !simple_request ) {
419 ber_clear( ber, 1 ); /* gack! */
420 if ( build_result_ber( ld, ber, lr )
422 ld->ld_errno = LDAP_NO_MEMORY;
423 rc = -1; /* fatal error */
427 ldap_free_request( ld, lr );
431 ldap_free_connection( ld, lc, 0, 1 );
436 if ( ber->ber_buf == NULL ) {
440 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
441 /* make a new ldap message */
442 if ( (new = (LDAPMessage *) calloc( 1, sizeof(LDAPMessage) ))
444 ld->ld_errno = LDAP_NO_MEMORY;
447 new->lm_msgid = (int)id;
448 new->lm_msgtype = tag;
449 new->lm_ber = ber_dup( ber );
450 ber_clear( ber, 0 ); /* don't kill buffer */
453 if ( ld->ld_cache != NULL ) {
454 ldap_add_result_to_cache( ld, new );
456 #endif /* LDAP_NOCACHE */
458 /* is this the one we're looking for? */
459 if ( msgid == LDAP_RES_ANY || id == msgid ) {
461 || (new->lm_msgtype != LDAP_RES_SEARCH_RESULT
462 && new->lm_msgtype != LDAP_RES_SEARCH_ENTRY) ) {
464 ld->ld_errno = LDAP_SUCCESS;
466 } else if ( new->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
467 foundit = 1; /* return the chain later */
472 * if not, we must add it to the list of responses. if
473 * the msgid is already there, it must be part of an existing
478 for ( l = ld->ld_responses; l != NULLMSG; l = l->lm_next ) {
479 if ( l->lm_msgid == new->lm_msgid )
484 /* not part of an existing search response */
485 if ( l == NULLMSG ) {
488 ld->ld_errno = LDAP_SUCCESS;
492 new->lm_next = ld->ld_responses;
493 ld->ld_responses = new;
494 return( -2 ); /* continue looking */
497 Debug( LDAP_DEBUG_TRACE, "adding response id %d type %d:\n",
498 new->lm_msgid, new->lm_msgtype, 0 );
500 /* part of a search response - add to end of list of entries */
501 for ( tmp = l; tmp->lm_chain != NULLMSG &&
502 tmp->lm_chain->lm_msgtype == LDAP_RES_SEARCH_ENTRY;
503 tmp = tmp->lm_chain )
507 /* return the whole chain if that's what we were looking for */
509 if ( prev == NULLMSG )
510 ld->ld_responses = l->lm_next;
512 prev->lm_next = l->lm_next;
514 ld->ld_errno = LDAP_SUCCESS;
515 #ifdef LDAP_WORLD_P16
517 * XXX questionable fix; see text for [P16] on
518 * http://www.critical-angle.com/ldapworld/patch/
520 * inclusion of this patch causes searchs to hang on
523 return( l->lm_msgtype );
524 #else /* LDAP_WORLD_P16 */
526 #endif /* !LDAP_WORLD_P16 */
529 return( -2 ); /* continue looking */
533 #ifdef LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS
535 build_result_ber( LDAP *ld, BerElement *ber, LDAPRequest *lr )
540 ber_init_w_nullc( ber, 0 );
541 ldap_set_ber_options( ld, ber );
542 if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
543 (unsigned long) lr->lr_res_msgtype, lr->lr_res_errno,
544 lr->lr_res_matched ? lr->lr_res_matched : "",
545 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 ) {
546 return( LBER_ERROR );
550 if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
551 return( LBER_ERROR );
554 if ( ber_get_int( ber, &along ) == LBER_ERROR ) {
555 return( LBER_ERROR );
558 return( ber_peek_tag( ber, &len ));
563 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
566 * Merge error information in "lr" with "parentr" error code and string.
568 if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
569 parentr->lr_res_errno = lr->lr_res_errno;
570 if ( lr->lr_res_error != NULL ) {
571 (void)ldap_append_referral( ld, &parentr->lr_res_error,
574 } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
575 parentr->lr_res_errno == LDAP_SUCCESS ) {
576 parentr->lr_res_errno = lr->lr_res_errno;
577 if ( parentr->lr_res_error != NULL ) {
578 free( parentr->lr_res_error );
580 parentr->lr_res_error = lr->lr_res_error;
581 lr->lr_res_error = NULL;
582 if ( LDAP_NAME_ERROR( lr->lr_res_errno )) {
583 if ( parentr->lr_res_matched != NULL ) {
584 free( parentr->lr_res_matched );
586 parentr->lr_res_matched = lr->lr_res_matched;
587 lr->lr_res_matched = NULL;
591 Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info: ",
592 parentr->lr_msgid, 0, 0 );
593 Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
594 parentr->lr_res_errno, parentr->lr_res_error ?
595 parentr->lr_res_error : "", parentr->lr_res_matched ?
596 parentr->lr_res_matched : "" );
598 #endif /* LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
602 #if defined( LDAP_CONNECTIONLESS ) || !defined( LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS )
605 ldap_select1( LDAP *ld, struct timeval *timeout )
610 if ( tblsize == 0 ) {
612 tblsize = sysconf( _SC_OPEN_MAX );
613 #elif HAVE_GETDTABLESIZE
614 tblsize = getdtablesize();
616 tblsize = FD_SETSIZE;
619 if ( tblsize > FD_SETSIZE ) {
620 tblsize = FD_SETSIZE;
622 #endif /* FD_SETSIZE */
626 FD_SET( ber_pvt_sb_get_desc(&ld->ld_sb), &readfds );
628 return( select( tblsize, &readfds, 0, 0, timeout ) );
631 #endif /* !LDAP_API_FEATURE_X_OPENLDAP_V2_REFERRALS */
635 ldap_msgtype( LDAPMessage *lm )
637 return( lm ? lm->lm_msgtype : -1 );
641 ldap_msgid( LDAPMessage *lm )
643 return( lm ? lm->lm_msgid : -1 );
648 ldap_msgfree( LDAPMessage *lm )
653 Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
655 for ( ; lm != NULLMSG; lm = next ) {
657 type = lm->lm_msgtype;
658 ber_free( lm->lm_ber, 1 );
666 * ldap_msgdelete - delete a message. It returns:
667 * 0 if the entire message was deleted
668 * -1 if the message was not found, or only part of it was found
671 ldap_msgdelete( LDAP *ld, int msgid )
673 LDAPMessage *lm, *prev;
675 Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
678 for ( lm = ld->ld_responses; lm != NULLMSG; lm = lm->lm_next ) {
679 if ( lm->lm_msgid == msgid )
687 if ( prev == NULLMSG )
688 ld->ld_responses = lm->lm_next;
690 prev->lm_next = lm->lm_next;
692 if ( ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
700 * return 1 if message msgid is waiting to be abandoned, 0 otherwise
703 ldap_abandoned( LDAP *ld, int msgid )
707 if ( ld->ld_abandoned == NULL )
710 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
711 if ( ld->ld_abandoned[i] == msgid )
719 ldap_mark_abandoned( LDAP *ld, int msgid )
723 if ( ld->ld_abandoned == NULL )
726 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
727 if ( ld->ld_abandoned[i] == msgid )
730 if ( ld->ld_abandoned[i] == -1 )
733 for ( ; ld->ld_abandoned[i] != -1; i++ ) {
734 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];
741 #ifdef LDAP_CONNECTIONLESS
743 cldap_getmsg( LDAP *ld, struct timeval *timeout, BerElement *ber )
746 unsigned long tag, len;
748 if ( ! ber_pvt_sb_data_ready(&ld->ld_sb) ) {
749 rc = ldap_select1( ld, timeout );
750 if ( rc == -1 || rc == 0 ) {
751 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
757 /* get the next message */
758 if ( (tag = ber_get_next( &ld->ld_sb, &len, ber ))
759 != LDAP_TAG_MESSAGE ) {
760 ld->ld_errno = (tag == LBER_DEFAULT ? LDAP_SERVER_DOWN :
767 #endif /* LDAP_CONNECTIONLESS */