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 static int try_read1msg LDAP_P(( LDAP *ld, int msgid, int all, Sockbuf *sb, LDAPConn *lc,
31 LDAPMessage **result ));
32 static unsigned long build_result_ber LDAP_P(( LDAP *ld, BerElement *ber, LDAPRequest *lr ));
33 static void merge_error_info LDAP_P(( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr ));
37 * ldap_result - wait for an ldap result response to a message from the
38 * ldap server. If msgid is -1, any message will be accepted, otherwise
39 * ldap_result will wait for a response with msgid. If all is 0 the
40 * first message with id msgid will be accepted, otherwise, ldap_result
41 * will wait for all responses with id msgid and then return a pointer to
42 * the entire list of messages. This is only useful for search responses,
43 * which can be of two message types (zero or more entries, followed by an
44 * ldap result). The type of the first message received is returned.
45 * When waiting, any messages that have been abandoned are discarded.
48 * ldap_result( s, msgid, all, timeout, result )
51 ldap_result( LDAP *ld, int msgid, int all, struct timeval *timeout,
52 LDAPMessage **result )
54 LDAPMessage *lm, *lastlm, *nextlm;
57 assert( result != NULL );
59 Debug( LDAP_DEBUG_TRACE, "ldap_result\n", 0, 0, 0 );
65 if( result == NULL ) {
66 ld->ld_errno = LDAP_PARAM_ERROR;
71 * First, look through the list of responses we have received on
72 * this association and see if the response we're interested in
73 * is there. If it is, return it. If not, call wait4msg() to
74 * wait until it arrives or timeout occurs.
79 for ( lm = ld->ld_responses; lm != NULLMSG; lm = nextlm ) {
82 if ( ldap_abandoned( ld, lm->lm_msgid ) ) {
83 ldap_mark_abandoned( ld, lm->lm_msgid );
85 if ( lastlm == NULLMSG ) {
86 ld->ld_responses = lm->lm_next;
88 lastlm->lm_next = nextlm;
96 if ( msgid == LDAP_RES_ANY || lm->lm_msgid == msgid ) {
100 || (lm->lm_msgtype != LDAP_RES_SEARCH_RESULT
101 && lm->lm_msgtype != LDAP_RES_SEARCH_REFERENCE /* LDAPv3 */
102 && lm->lm_msgtype != LDAP_RES_SEARCH_ENTRY) )
105 for ( tmp = lm; tmp != NULLMSG; tmp = tmp->lm_chain ) {
106 if ( tmp->lm_msgtype == LDAP_RES_SEARCH_RESULT )
110 if ( tmp == NULLMSG ) {
111 return( wait4msg( ld, msgid, all, timeout,
119 if ( lm == NULLMSG ) {
120 return( wait4msg( ld, msgid, all, timeout, result ) );
123 if ( lastlm == NULLMSG ) {
124 ld->ld_responses = (all == 0 && lm->lm_chain != NULLMSG
125 ? lm->lm_chain : lm->lm_next);
127 lastlm->lm_next = (all == 0 && lm->lm_chain != NULLMSG
128 ? lm->lm_chain : lm->lm_next);
131 lm->lm_chain = NULLMSG;
132 lm->lm_next = NULLMSG;
135 ld->ld_errno = LDAP_SUCCESS;
136 return( lm->lm_msgtype );
140 wait4msg( LDAP *ld, int msgid, int all, struct timeval *timeout,
141 LDAPMessage **result )
144 struct timeval tv, *tvp;
145 time_t start_time = 0;
147 LDAPConn *lc, *nextlc;
149 assert( ld != NULL );
150 assert( result != NULL );
153 if ( timeout == NULL ) {
154 Debug( LDAP_DEBUG_TRACE, "wait4msg (infinite timeout)\n",
157 Debug( LDAP_DEBUG_TRACE, "wait4msg (timeout %ld sec, %ld usec)\n",
158 (long) timeout->tv_sec, (long) timeout->tv_usec, 0 );
160 #endif /* LDAP_DEBUG */
162 if ( timeout == NULL ) {
167 start_time = time( NULL );
173 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
174 ldap_dump_connection( ld, ld->ld_conns, 1 );
175 ldap_dump_requests_and_responses( ld );
177 #endif /* LDAP_DEBUG */
178 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
179 if ( ber_pvt_sb_data_ready(lc->lconn_sb) ) {
180 rc = try_read1msg( ld, msgid, all, lc->lconn_sb,
187 rc = do_ldap_select( ld, tvp );
192 Debug( LDAP_DEBUG_TRACE,
193 "do_ldap_select returned -1: errno %d\n",
198 if ( rc == 0 || ( rc == -1 && (
199 ( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
201 || errno != EINTR )))
203 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
209 rc = -2; /* select interrupted: loop */
212 for ( lc = ld->ld_conns; rc == -2 && lc != NULL;
214 nextlc = lc->lconn_next;
215 if ( lc->lconn_status ==
216 LDAP_CONNST_CONNECTED &&
217 ldap_is_read_ready( ld,
219 rc = try_read1msg( ld, msgid, all,
220 lc->lconn_sb, lc, result );
226 if ( rc == -2 && tvp != NULL ) {
227 tmp_time = time( NULL );
228 if (( tv.tv_sec -= ( tmp_time - start_time )) <= 0 ) {
229 rc = 0; /* timed out */
230 ld->ld_errno = LDAP_TIMEOUT;
234 Debug( LDAP_DEBUG_TRACE, "wait4msg: %ld secs to go\n",
235 (long) tv.tv_sec, 0, 0 );
236 start_time = tmp_time;
245 try_read1msg( LDAP *ld, int msgid, int all, Sockbuf *sb,
246 LDAPConn *lc, LDAPMessage **result )
249 LDAPMessage *new, *l, *prev, *tmp;
251 unsigned long tag, len;
255 int rc, refer_cnt, hadref, simple_request;
258 assert( ld != NULL );
259 assert( lc != NULL );
261 ber = &lc->lconn_ber;
263 Debug( LDAP_DEBUG_TRACE, "read1msg\n", 0, 0, 0 );
266 ber_init_w_nullc( &ber, 0 );
267 ldap_set_ber_options( ld, &ber );
270 /* get the next message */
271 if ( (tag = ber_get_next( sb, &len, ber ))
272 != LDAP_TAG_MESSAGE ) {
273 if ( tag == LBER_DEFAULT) {
275 Debug( LDAP_DEBUG_CONNS,
276 "ber_get_next failed.\n", 0, 0, 0 );
279 if (errno==EWOULDBLOCK) return -2;
282 if (errno == EAGAIN) return -2;
284 ld->ld_errno = LDAP_SERVER_DOWN;
287 ld->ld_errno = LDAP_LOCAL_ERROR;
292 if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
293 ld->ld_errno = LDAP_DECODING_ERROR;
297 /* if it's been abandoned, toss it */
298 if ( ldap_abandoned( ld, (int)id ) ) {
299 ber_clear( ber, 1 ); /* gack! */
300 return( -2 ); /* continue looking */
303 if (( lr = ldap_find_request_by_msgid( ld, id )) == NULL ) {
304 Debug( LDAP_DEBUG_ANY,
305 "no request for response with msgid %ld (tossing)\n",
307 ber_clear( ber, 1 ); /* gack! */
308 return( -2 ); /* continue looking */
310 Debug( LDAP_DEBUG_TRACE, "ldap_read: %s msgid %ld, original id %d\n",
311 ( tag == LDAP_RES_SEARCH_ENTRY ) ? "entry" :
312 ( tag == LDAP_RES_SEARCH_REFERENCE ) ? "reference" : "result",
316 /* the message type */
317 if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
318 ld->ld_errno = LDAP_DECODING_ERROR;
323 hadref = simple_request = 0;
324 rc = -2; /* default is to keep looking (no response found) */
325 lr->lr_res_msgtype = tag;
327 if ( tag != LDAP_RES_SEARCH_ENTRY ) {
328 if ( ld->ld_version >= LDAP_VERSION2 &&
329 ( lr->lr_parent != NULL ||
330 ( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
331 != LDAP_OPT_OFF ) ) )
333 tmpber = *ber; /* struct copy */
334 if ( ber_scanf( &tmpber, "{iaa}", &lderr,
335 &lr->lr_res_matched, &lr->lr_res_error )
337 if ( lderr != LDAP_SUCCESS ) {
338 /* referrals are in error string */
339 refer_cnt = ldap_chase_referrals( ld, lr,
340 &lr->lr_res_error, &hadref );
343 /* save errno, message, and matched string */
344 if ( !hadref || lr->lr_res_error == NULL ) {
345 lr->lr_res_errno = ( lderr ==
346 LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
348 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
349 lr->lr_res_errno = ld->ld_errno;
351 lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
353 Debug( LDAP_DEBUG_TRACE,
354 "new result: res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
355 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
356 lr->lr_res_matched ? lr->lr_res_matched : "" );
360 Debug( LDAP_DEBUG_TRACE,
361 "read1msg: %d new referrals\n", refer_cnt, 0, 0 );
363 if ( refer_cnt != 0 ) { /* chasing referrals */
364 ber_clear( ber, 1 ); /* gack! */
365 if ( refer_cnt < 0 ) {
366 return( -1 ); /* fatal error */
368 lr->lr_status = LDAP_REQST_CHASINGREFS;
370 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
371 /* request without any referrals */
372 simple_request = ( hadref ? 0 : 1 );
374 /* request with referrals or child request */
375 ber_clear( ber, 1 ); /* gack! */
378 while ( lr->lr_parent != NULL ) {
379 merge_error_info( ld, lr->lr_parent, lr );
382 if ( --lr->lr_outrefcnt > 0 ) {
383 break; /* not completely done yet */
387 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
389 tag = lr->lr_res_msgtype;
390 Debug( LDAP_DEBUG_ANY, "request %ld done\n",
392 Debug( LDAP_DEBUG_TRACE,
393 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
394 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
395 lr->lr_res_matched ? lr->lr_res_matched : "" );
396 if ( !simple_request ) {
397 ber_clear( ber, 1 ); /* gack! */
398 if ( build_result_ber( ld, ber, lr )
400 ld->ld_errno = LDAP_NO_MEMORY;
401 rc = -1; /* fatal error */
405 ldap_free_request( ld, lr );
409 ldap_free_connection( ld, lc, 0, 1 );
414 if ( ber->ber_buf == NULL ) {
418 /* make a new ldap message */
419 if ( (new = (LDAPMessage *) calloc( 1, sizeof(LDAPMessage) ))
421 ld->ld_errno = LDAP_NO_MEMORY;
424 new->lm_msgid = (int)id;
425 new->lm_msgtype = tag;
426 new->lm_ber = ber_dup( ber );
427 ber_clear( ber, 0 ); /* don't kill buffer */
430 if ( ld->ld_cache != NULL ) {
431 ldap_add_result_to_cache( ld, new );
433 #endif /* LDAP_NOCACHE */
435 /* is this the one we're looking for? */
436 if ( msgid == LDAP_RES_ANY || id == msgid ) {
438 || (new->lm_msgtype != LDAP_RES_SEARCH_RESULT
439 && new->lm_msgtype != LDAP_RES_SEARCH_ENTRY) ) {
441 ld->ld_errno = LDAP_SUCCESS;
443 } else if ( new->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
444 foundit = 1; /* return the chain later */
449 * if not, we must add it to the list of responses. if
450 * the msgid is already there, it must be part of an existing
455 for ( l = ld->ld_responses; l != NULLMSG; l = l->lm_next ) {
456 if ( l->lm_msgid == new->lm_msgid )
461 /* not part of an existing search response */
462 if ( l == NULLMSG ) {
465 ld->ld_errno = LDAP_SUCCESS;
469 new->lm_next = ld->ld_responses;
470 ld->ld_responses = new;
471 return( -2 ); /* continue looking */
474 Debug( LDAP_DEBUG_TRACE, "adding response id %d type %d:\n",
475 new->lm_msgid, new->lm_msgtype, 0 );
477 /* part of a search response - add to end of list of entries */
478 for ( tmp = l; tmp->lm_chain != NULLMSG &&
479 tmp->lm_chain->lm_msgtype == LDAP_RES_SEARCH_ENTRY;
480 tmp = tmp->lm_chain )
484 /* return the whole chain if that's what we were looking for */
486 if ( prev == NULLMSG )
487 ld->ld_responses = l->lm_next;
489 prev->lm_next = l->lm_next;
491 ld->ld_errno = LDAP_SUCCESS;
492 #ifdef LDAP_WORLD_P16
494 * XXX questionable fix; see text for [P16] on
495 * http://www.critical-angle.com/ldapworld/patch/
497 * inclusion of this patch causes searchs to hang on
500 return( l->lm_msgtype );
501 #else /* LDAP_WORLD_P16 */
503 #endif /* !LDAP_WORLD_P16 */
506 return( -2 ); /* continue looking */
511 build_result_ber( LDAP *ld, BerElement *ber, LDAPRequest *lr )
516 ber_init_w_nullc( ber, 0 );
517 ldap_set_ber_options( ld, ber );
518 if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
519 (unsigned long) lr->lr_res_msgtype, lr->lr_res_errno,
520 lr->lr_res_matched ? lr->lr_res_matched : "",
521 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 ) {
522 return( LBER_ERROR );
526 if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
527 return( LBER_ERROR );
530 if ( ber_get_int( ber, &along ) == LBER_ERROR ) {
531 return( LBER_ERROR );
534 return( ber_peek_tag( ber, &len ));
539 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
542 * Merge error information in "lr" with "parentr" error code and string.
544 if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
545 parentr->lr_res_errno = lr->lr_res_errno;
546 if ( lr->lr_res_error != NULL ) {
547 (void)ldap_append_referral( ld, &parentr->lr_res_error,
550 } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
551 parentr->lr_res_errno == LDAP_SUCCESS ) {
552 parentr->lr_res_errno = lr->lr_res_errno;
553 if ( parentr->lr_res_error != NULL ) {
554 free( parentr->lr_res_error );
556 parentr->lr_res_error = lr->lr_res_error;
557 lr->lr_res_error = NULL;
558 if ( LDAP_NAME_ERROR( lr->lr_res_errno )) {
559 if ( parentr->lr_res_matched != NULL ) {
560 free( parentr->lr_res_matched );
562 parentr->lr_res_matched = lr->lr_res_matched;
563 lr->lr_res_matched = NULL;
567 Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info: ",
568 parentr->lr_msgid, 0, 0 );
569 Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
570 parentr->lr_res_errno, parentr->lr_res_error ?
571 parentr->lr_res_error : "", parentr->lr_res_matched ?
572 parentr->lr_res_matched : "" );
578 ldap_msgtype( LDAPMessage *lm )
580 assert( lm != NULL );
581 return ( lm == NULL ) ? lm->lm_msgtype : -1;
586 ldap_msgid( LDAPMessage *lm )
588 assert( lm != NULL );
590 return ( lm == NULL ) ? lm->lm_msgid : -1;
595 ldap_msgfree( LDAPMessage *lm )
600 assert( lm != NULL );
602 Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
604 for ( ; lm != NULLMSG; lm = next ) {
606 type = lm->lm_msgtype;
607 ber_free( lm->lm_ber, 1 );
615 * ldap_msgdelete - delete a message. It returns:
616 * 0 if the entire message was deleted
617 * -1 if the message was not found, or only part of it was found
620 ldap_msgdelete( LDAP *ld, int msgid )
622 LDAPMessage *lm, *prev;
624 assert( ld != NULL );
626 Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
629 for ( lm = ld->ld_responses; lm != NULLMSG; lm = lm->lm_next ) {
630 if ( lm->lm_msgid == msgid )
638 if ( prev == NULLMSG )
639 ld->ld_responses = lm->lm_next;
641 prev->lm_next = lm->lm_next;
643 if ( ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
651 * return 1 if message msgid is waiting to be abandoned, 0 otherwise
654 ldap_abandoned( LDAP *ld, int msgid )
658 if ( ld->ld_abandoned == NULL )
661 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
662 if ( ld->ld_abandoned[i] == msgid )
670 ldap_mark_abandoned( LDAP *ld, int msgid )
674 if ( ld->ld_abandoned == NULL )
677 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
678 if ( ld->ld_abandoned[i] == msgid )
681 if ( ld->ld_abandoned[i] == -1 )
684 for ( ; ld->ld_abandoned[i] != -1; i++ ) {
685 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];
692 #ifdef LDAP_CONNECTIONLESS
694 cldap_getmsg( LDAP *ld, struct timeval *timeout, BerElement *ber )
697 unsigned long tag, len;
699 if ( ! ber_pvt_sb_data_ready(&ld->ld_sb) ) {
700 rc = ldap_select1( ld, timeout );
701 if ( rc == -1 || rc == 0 ) {
702 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
708 /* get the next message */
709 if ( (tag = ber_get_next( &ld->ld_sb, &len, ber ))
710 != LDAP_TAG_MESSAGE ) {
711 ld->ld_errno = (tag == LBER_DEFAULT ? LDAP_SERVER_DOWN :
718 #endif /* LDAP_CONNECTIONLESS */