1 /* result.c - wait for an ldap result */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 1998-2006 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
12 * A copy of this license is available in the file LICENSE in the
13 * top-level directory of the distribution or, alternatively, at
14 * <http://www.OpenLDAP.org/license.html>.
16 /* Portions Copyright (c) 1990 Regents of the University of Michigan.
17 * All rights reserved.
19 /* This notice applies to changes, created by or for Novell, Inc.,
20 * to preexisting works for which notices appear elsewhere in this file.
22 * Copyright (C) 1999, 2000 Novell, Inc. All Rights Reserved.
24 * THIS WORK IS SUBJECT TO U.S. AND INTERNATIONAL COPYRIGHT LAWS AND TREATIES.
25 * USE, MODIFICATION, AND REDISTRIBUTION OF THIS WORK IS SUBJECT TO VERSION
26 * 2.0.1 OF THE OPENLDAP PUBLIC LICENSE, A COPY OF WHICH IS AVAILABLE AT
27 * HTTP://WWW.OPENLDAP.ORG/LICENSE.HTML OR IN THE FILE "LICENSE" IN THE
28 * TOP-LEVEL DIRECTORY OF THE DISTRIBUTION. ANY USE OR EXPLOITATION OF THIS
29 * WORK OTHER THAN AS AUTHORIZED IN VERSION 2.0.1 OF THE OPENLDAP PUBLIC
30 * LICENSE, OR OTHER PRIOR WRITTEN CONSENT FROM NOVELL, COULD SUBJECT THE
31 * PERPETRATOR TO CRIMINAL AND CIVIL LIABILITY.
33 * Modification to OpenLDAP source by Novell, Inc.
34 * April 2000 sfs Add code to process V3 referrals and search results
36 * Note: A verbatim copy of version 2.0.1 of the OpenLDAP Public License
37 * can be found in the file "build/LICENSE-2.0.1" in this distribution
38 * of OpenLDAP Software.
40 /* Portions Copyright (C) The Internet Society (2006)
41 * ASN.1 fragments are from RFC 4511; see RFC for full legal notices.
46 * LDAPResult ::= SEQUENCE {
47 * resultCode ENUMERATED { ... },
49 * diagnosticMessage LDAPString,
50 * referral [3] Referral OPTIONAL
52 * Referral ::= SEQUENCE OF LDAPURL (one or more)
53 * LDAPURL ::= LDAPString (limited to URL chars)
60 #include <ac/stdlib.h>
63 #include <ac/socket.h>
64 #include <ac/string.h>
66 #include <ac/unistd.h>
71 static int ldap_abandoned LDAP_P(( LDAP *ld, ber_int_t msgid ));
72 static int ldap_mark_abandoned LDAP_P(( LDAP *ld, ber_int_t msgid ));
73 static int wait4msg LDAP_P(( LDAP *ld, ber_int_t msgid, int all, struct timeval *timeout,
74 LDAPMessage **result ));
75 static ber_tag_t try_read1msg LDAP_P(( LDAP *ld, ber_int_t msgid,
76 int all, LDAPConn **lc, LDAPMessage **result ));
77 static ber_tag_t build_result_ber LDAP_P(( LDAP *ld, BerElement **bp, LDAPRequest *lr ));
78 static void merge_error_info LDAP_P(( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr ));
79 static LDAPMessage * chkResponseList LDAP_P(( LDAP *ld, int msgid, int all));
81 #define LDAP_MSG_X_KEEP_LOOKING (-2)
85 * ldap_result - wait for an ldap result response to a message from the
86 * ldap server. If msgid is LDAP_RES_ANY (-1), any message will be
87 * accepted. If msgid is LDAP_RES_UNSOLICITED (0), any unsolicited
88 * message is accepted. Otherwise ldap_result will wait for a response
89 * with msgid. If all is LDAP_MSG_ONE (0) the first message with id
90 * msgid will be accepted, otherwise, ldap_result will wait for all
91 * responses with id msgid and then return a pointer to the entire list
92 * of messages. In general, this is only useful for search responses,
93 * which can be of three message types (zero or more entries, zero or
94 * search references, followed by an ldap result). An extension to
95 * LDAPv3 allows partial extended responses to be returned in response
96 * to any request. The type of the first message received is returned.
97 * When waiting, any messages that have been abandoned are discarded.
100 * ldap_result( s, msgid, all, timeout, result )
107 struct timeval *timeout,
108 LDAPMessage **result )
113 assert( ld != NULL );
114 assert( result != NULL );
116 Debug( LDAP_DEBUG_TRACE, "ldap_result ld %p msgid %d\n", (void *)ld, msgid, 0 );
118 #ifdef LDAP_R_COMPILE
119 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
121 lm = chkResponseList(ld, msgid, all);
124 rc = wait4msg( ld, msgid, all, timeout, result );
127 ld->ld_errno = LDAP_SUCCESS;
130 #ifdef LDAP_R_COMPILE
131 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
142 LDAPMessage *lm, **lastlm, *nextlm;
145 * Look through the list of responses we have received on
146 * this association and see if the response we're interested in
147 * is there. If it is, return it. If not, call wait4msg() to
148 * wait until it arrives or timeout occurs.
151 #ifdef LDAP_R_COMPILE
152 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
155 Debug( LDAP_DEBUG_TRACE,
156 "ldap_chkResponseList ld %p msgid %d all %d\n",
157 (void *)ld, msgid, all );
159 lastlm = &ld->ld_responses;
160 for ( lm = ld->ld_responses; lm != NULL; lm = nextlm ) {
161 nextlm = lm->lm_next;
163 if ( ldap_abandoned( ld, lm->lm_msgid ) ) {
164 Debug( LDAP_DEBUG_TRACE,
165 "ldap_chkResponseList msg abandoned, msgid %d\n",
167 ldap_mark_abandoned( ld, lm->lm_msgid );
169 /* Remove this entry from list */
177 if ( msgid == LDAP_RES_ANY || lm->lm_msgid == msgid ) {
180 if ( all == LDAP_MSG_ONE || all == LDAP_MSG_RECEIVED ||
181 msgid == LDAP_RES_UNSOLICITED ) {
185 tmp = lm->lm_chain_tail;
186 if ((tmp->lm_msgtype == LDAP_RES_SEARCH_ENTRY) ||
187 (tmp->lm_msgtype == LDAP_RES_SEARCH_REFERENCE) ||
188 (tmp->lm_msgtype == LDAP_RES_INTERMEDIATE)) {
198 lastlm = &lm->lm_next;
202 /* Found an entry, remove it from the list */
203 if ( all == LDAP_MSG_ONE && lm->lm_chain != NULL ) {
204 *lastlm = lm->lm_chain;
205 lm->lm_chain->lm_next = lm->lm_next;
206 lm->lm_chain->lm_chain_tail = ( lm->lm_chain_tail != lm ) ? lm->lm_chain_tail : lm->lm_chain;
208 lm->lm_chain_tail = NULL;
210 *lastlm = lm->lm_next;
217 Debug( LDAP_DEBUG_TRACE,
218 "ldap_chkResponseList returns ld %p NULL\n", (void *)ld, 0, 0);
220 Debug( LDAP_DEBUG_TRACE,
221 "ldap_chkResponseList returns ld %p msgid %d, type 0x%02lu\n",
222 (void *)ld, lm->lm_msgid, (unsigned long) lm->lm_msgtype);
233 struct timeval *timeout,
234 LDAPMessage **result )
237 struct timeval tv = { 0 },
240 time_t start_time = 0;
244 assert( ld != NULL );
245 assert( result != NULL );
247 #ifdef LDAP_R_COMPILE
248 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
252 if ( timeout == NULL ) {
253 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p msgid %d (infinite timeout)\n",
254 (void *)ld, msgid, 0 );
256 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p msgid %d (timeout %ld usec)\n",
257 (void *)ld, msgid, (long)timeout->tv_sec * 1000000 + timeout->tv_usec );
259 #endif /* LDAP_DEBUG */
261 if ( timeout == NULL ) {
267 start_time = time( NULL );
270 rc = LDAP_MSG_X_KEEP_LOOKING;
271 while ( rc == LDAP_MSG_X_KEEP_LOOKING ) {
273 if ( ldap_debug & LDAP_DEBUG_TRACE ) {
274 Debug( LDAP_DEBUG_TRACE, "wait4msg continue ld %p msgid %d all %d\n",
275 (void *)ld, msgid, all );
276 #ifdef LDAP_R_COMPILE
277 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
279 ldap_dump_connection( ld, ld->ld_conns, 1 );
280 #ifdef LDAP_R_COMPILE
281 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
282 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
284 ldap_dump_requests_and_responses( ld );
285 #ifdef LDAP_R_COMPILE
286 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
289 #endif /* LDAP_DEBUG */
291 if ( ( *result = chkResponseList( ld, msgid, all ) ) != NULL ) {
292 rc = (*result)->lm_msgtype;
297 #ifdef LDAP_R_COMPILE
298 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
300 for ( lc = ld->ld_conns; lc != NULL; lc = lc->lconn_next ) {
301 if ( ber_sockbuf_ctrl( lc->lconn_sb,
302 LBER_SB_OPT_DATA_READY, NULL ) )
304 #ifdef LDAP_R_COMPILE
305 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
307 rc = try_read1msg( ld, msgid, all, &lc, result );
308 #ifdef LDAP_R_COMPILE
309 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
315 #ifdef LDAP_R_COMPILE
316 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
320 rc = ldap_int_select( ld, tvp );
323 Debug( LDAP_DEBUG_TRACE,
324 "ldap_int_select returned -1: errno %d\n",
329 if ( rc == 0 || ( rc == -1 && (
330 !LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
331 || errno != EINTR ) ) )
333 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
339 rc = LDAP_MSG_X_KEEP_LOOKING; /* select interrupted: loop */
341 rc = LDAP_MSG_X_KEEP_LOOKING;
342 #ifdef LDAP_R_COMPILE
343 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
345 if ( ld->ld_requests &&
346 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
347 ldap_is_write_ready( ld,
348 ld->ld_requests->lr_conn->lconn_sb ) )
350 ldap_int_flush_request( ld, ld->ld_requests );
352 #ifdef LDAP_R_COMPILE
353 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
354 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
356 for ( lc = ld->ld_conns;
357 rc == LDAP_MSG_X_KEEP_LOOKING && lc != NULL;
358 lc = lc->lconn_next )
360 if ( lc->lconn_status == LDAP_CONNST_CONNECTED &&
361 ldap_is_read_ready( ld, lc->lconn_sb ) )
363 #ifdef LDAP_R_COMPILE
364 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
366 rc = try_read1msg( ld, msgid, all, &lc, result );
367 #ifdef LDAP_R_COMPILE
368 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
371 /* if lc gets free()'d,
372 * there's no guarantee
373 * lc->lconn_next is still
374 * sane; better restart
380 #ifdef LDAP_R_COMPILE
381 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
387 if ( rc == LDAP_MSG_X_KEEP_LOOKING && tvp != NULL ) {
388 tmp_time = time( NULL );
389 tv0.tv_sec -= ( tmp_time - start_time );
390 if ( tv0.tv_sec <= 0 ) {
391 rc = 0; /* timed out */
392 ld->ld_errno = LDAP_TIMEOUT;
395 tv.tv_sec = tv0.tv_sec;
397 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p %ld secs to go\n",
398 (void *)ld, (long) tv.tv_sec, 0 );
399 start_time = tmp_time;
413 LDAPMessage **result )
416 LDAPMessage *newmsg, *l, *prev;
421 LDAPRequest *lr, *tmplr;
424 int rc, refer_cnt, hadref, simple_request;
427 #ifdef LDAP_CONNECTIONLESS
428 LDAPMessage *tmp = NULL, *chain_head = NULL;
429 int moremsgs = 0, isv2 = 0;
433 * v3ref = flag for V3 referral / search reference
434 * 0 = not a ref, 1 = sucessfully chased ref, -1 = pass ref to application
442 assert( ld != NULL );
443 assert( lcp != NULL );
444 assert( *lcp != NULL );
446 #ifdef LDAP_R_COMPILE
447 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
450 Debug( LDAP_DEBUG_TRACE, "read1msg: ld %p msgid %d all %d\n",
451 (void *)ld, msgid, all );
456 if ( lc->lconn_ber == NULL ) {
457 lc->lconn_ber = ldap_alloc_ber_with_options( ld );
459 if( lc->lconn_ber == NULL ) {
465 assert( LBER_VALID (ber) );
467 /* get the next message */
469 #ifdef LDAP_CONNECTIONLESS
470 if ( LDAP_IS_UDP(ld) ) {
471 struct sockaddr from;
472 ber_int_sb_read( lc->lconn_sb, &from, sizeof(struct sockaddr) );
473 if (ld->ld_options.ldo_version == LDAP_VERSION2) isv2 = 1;
477 tag = ber_get_next( lc->lconn_sb, &len, ber );
479 case LDAP_TAG_MESSAGE:
481 * We read a complete message.
482 * The connection should no longer need this ber.
484 lc->lconn_ber = NULL;
489 Debug( LDAP_DEBUG_CONNS,
490 "ber_get_next failed.\n", 0, 0, 0 );
493 if ( errno == EWOULDBLOCK ) return LDAP_MSG_X_KEEP_LOOKING;
496 if ( errno == EAGAIN ) return LDAP_MSG_X_KEEP_LOOKING;
498 ld->ld_errno = LDAP_SERVER_DOWN;
502 ld->ld_errno = LDAP_LOCAL_ERROR;
507 if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
509 ld->ld_errno = LDAP_DECODING_ERROR;
513 /* if it's been abandoned, toss it */
514 if ( ldap_abandoned( ld, id ) ) {
515 Debug( LDAP_DEBUG_ANY, "abandoned ld %p msgid %ld\n",
516 (void *)ld, (long) id, 0);
519 if ( ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
522 return( LDAP_MSG_X_KEEP_LOOKING ); /* continue looking */
525 lr = ldap_find_request_by_msgid( ld, id );
527 Debug( LDAP_DEBUG_ANY,
528 "no request for response on ld %p msgid %ld (tossing)\n",
529 (void *)ld, (long)id, 0 );
532 #ifdef LDAP_CONNECTIONLESS
533 if (LDAP_IS_UDP(ld) && isv2) {
534 ber_scanf(ber, "x{");
538 /* the message type */
539 if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
540 ld->ld_errno = LDAP_DECODING_ERROR;
545 Debug( LDAP_DEBUG_TRACE,
546 "read1msg: ld %p msgid %ld message type %s\n",
547 (void *)ld, (long) lr->lr_msgid, ldap_int_msgtype2str( tag ));
551 hadref = simple_request = 0;
552 rc = LDAP_MSG_X_KEEP_LOOKING; /* default is to keep looking (no response found) */
553 lr->lr_res_msgtype = tag;
556 * This code figures out if we are going to chase a
557 * referral / search reference, or pass it back to the application
559 v3ref = V3REF_NOREF; /* Assume not a V3 search reference/referral */
560 if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
561 BerElement tmpber = *ber; /* struct copy */
564 if( tag == LDAP_RES_SEARCH_REFERENCE ) {
565 /* This is a V3 search reference */
566 /* Assume we do not chase the reference,
567 * but pass it to application */
569 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
570 (lr->lr_parent != NULL) )
572 /* Get the referral list */
573 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
574 rc = LDAP_DECODING_ERROR;
576 /* Note: refs array is freed by ldap_chase_v3referrals */
577 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
578 1, &lr->lr_res_error, &hadref );
579 if ( refer_cnt > 0 ) {
580 /* sucessfully chased reference */
581 /* If haven't got end search, set chasing referrals */
582 if ( lr->lr_status != LDAP_REQST_COMPLETED ) {
583 lr->lr_status = LDAP_REQST_CHASINGREFS;
584 Debug( LDAP_DEBUG_TRACE,
585 "read1msg: search ref chased, "
586 "mark request chasing refs, "
591 /* We sucessfully chased the reference */
592 v3ref = V3REF_SUCCESS;
597 /* Check for V3 referral */
599 char *lr_res_error = NULL;
601 if ( ber_scanf( &tmpber, "{eAA",/*}*/ &lderr,
602 &lr->lr_res_matched, &lr_res_error )
605 if ( lr_res_error != NULL ) {
607 if ( lr->lr_res_error != NULL ) {
608 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
609 LDAP_FREE( (char *)lr_res_error );
612 lr->lr_res_error = lr_res_error;
618 /* Check if V3 referral */
619 if ( ber_peek_tag( &tmpber, &len ) == LDAP_TAG_REFERRAL ) {
620 /* We have a V3 referral, assume we cannot chase it */
622 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
623 || (lr->lr_parent != NULL) )
625 /* Assume referral not chased and return it to app */
628 /* Get the referral list */
629 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
630 rc = LDAP_DECODING_ERROR;
631 lr->lr_status = LDAP_REQST_COMPLETED;
632 Debug( LDAP_DEBUG_TRACE,
633 "read1msg: referral decode error, mark request completed, ld %p msgid %d\n",
634 (void *)ld, lr->lr_msgid, 0);
636 /* Chase the referral
637 * Note: refs arrary is freed by ldap_chase_v3referrals
639 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
640 0, &lr->lr_res_error, &hadref );
641 lr->lr_status = LDAP_REQST_COMPLETED;
642 Debug( LDAP_DEBUG_TRACE,
643 "read1msg: referral chased, mark request completed, ld %p msgid %d\n",
644 (void *)ld, lr->lr_msgid, 0);
646 /* Referral successfully chased */
647 v3ref = V3REF_SUCCESS;
653 if( lr->lr_res_matched != NULL ) {
654 LDAP_FREE( lr->lr_res_matched );
655 lr->lr_res_matched = NULL;
657 if( lr->lr_res_error != NULL ) {
658 LDAP_FREE( lr->lr_res_error );
659 lr->lr_res_error = NULL;
665 /* All results that just return a status, i.e. don't return data
666 * go through the following code. This code also chases V2 referrals
667 * and checks if all referrals have been chased.
669 if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref != V3REF_TOAPP) &&
670 (tag != LDAP_RES_INTERMEDIATE ))
672 /* For a v3 search referral/reference, only come here if already chased it */
673 if ( ld->ld_version >= LDAP_VERSION2 &&
674 ( lr->lr_parent != NULL ||
675 LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
677 char *lr_res_error = NULL;
679 tmpber = *ber; /* struct copy */
680 if ( v3ref == V3REF_SUCCESS ) {
681 /* V3 search reference or V3 referral
682 * sucessfully chased. If this message
683 * is a search result, then it has no more
684 * outstanding referrals.
686 if ( tag == LDAP_RES_SEARCH_RESULT )
688 } else if ( ber_scanf( &tmpber, "{eAA}", &lderr,
689 &lr->lr_res_matched, &lr_res_error )
692 if ( lr_res_error != NULL ) {
693 if ( lr->lr_res_error != NULL ) {
694 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
695 LDAP_FREE( (char *)lr_res_error );
697 lr->lr_res_error = lr_res_error;
704 case LDAP_COMPARE_TRUE:
705 case LDAP_COMPARE_FALSE:
709 if ( lr->lr_res_error == NULL
710 || lr->lr_res_error[ 0 ] == '\0' )
715 /* referrals are in error string */
716 refer_cnt = ldap_chase_referrals( ld, lr,
717 &lr->lr_res_error, -1, &hadref );
718 lr->lr_status = LDAP_REQST_COMPLETED;
719 Debug( LDAP_DEBUG_TRACE,
720 "read1msg: V2 referral chased, "
721 "mark request completed, id = %d\n",
722 lr->lr_msgid, 0, 0 );
726 /* save errno, message, and matched string */
727 if ( !hadref || lr->lr_res_error == NULL ) {
728 lr->lr_res_errno = ( lderr ==
729 LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
731 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
732 lr->lr_res_errno = ld->ld_errno;
734 lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
737 Debug( LDAP_DEBUG_TRACE, "new result: "
740 "res_matched: <%s>\n",
742 lr->lr_res_error ? lr->lr_res_error : "",
743 lr->lr_res_matched ? lr->lr_res_matched : "" );
746 /* in any case, don't leave any lr_res_error 'round */
747 if ( lr_res_error ) {
748 LDAP_FREE( lr_res_error );
752 Debug( LDAP_DEBUG_TRACE,
753 "read1msg: ld %p %d new referrals\n",
754 (void *)ld, refer_cnt, 0 );
756 if ( refer_cnt != 0 ) { /* chasing referrals */
759 if ( refer_cnt < 0 ) {
760 return( -1 ); /* fatal error */
762 lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
764 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
765 /* request without any referrals */
766 simple_request = ( hadref ? 0 : 1 );
768 /* request with referrals or child request */
773 lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
774 Debug( LDAP_DEBUG_TRACE,
775 "read1msg: mark request completed, ld %p msgid %d\n",
776 (void *)ld, lr->lr_msgid, 0);
777 while ( lr->lr_parent != NULL ) {
778 merge_error_info( ld, lr->lr_parent, lr );
781 if ( --lr->lr_outrefcnt > 0 ) {
782 break; /* not completely done yet */
786 /* Check if all requests are finished, lr is now parent */
788 if ( tmplr->lr_status == LDAP_REQST_COMPLETED ) {
789 for ( tmplr=lr->lr_child;
791 tmplr=tmplr->lr_refnext)
793 if ( tmplr->lr_status != LDAP_REQST_COMPLETED ) break;
797 /* This is the parent request if the request has referrals */
798 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL &&
802 tag = lr->lr_res_msgtype;
803 Debug( LDAP_DEBUG_ANY, "request done: ld %p msgid %ld\n",
804 (void *)ld, (long) id, 0 );
805 Debug( LDAP_DEBUG_TRACE,
806 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
807 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
808 lr->lr_res_matched ? lr->lr_res_matched : "" );
809 if ( !simple_request ) {
812 if ( build_result_ber( ld, &ber, lr )
815 rc = -1; /* fatal error */
819 #ifdef LDAP_R_COMPILE
820 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
822 ldap_free_request( ld, lr );
823 #ifdef LDAP_R_COMPILE
824 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
829 #ifdef LDAP_R_COMPILE
830 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
832 ldap_free_connection( ld, lc, 0, 1 );
833 #ifdef LDAP_R_COMPILE
834 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
845 /* make a new ldap message */
846 newmsg = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) );
847 if ( newmsg == NULL ) {
848 ld->ld_errno = LDAP_NO_MEMORY;
851 newmsg->lm_msgid = (int)id;
852 newmsg->lm_msgtype = tag;
853 newmsg->lm_ber = ber;
854 newmsg->lm_chain_tail = newmsg;
856 #ifdef LDAP_CONNECTIONLESS
857 /* CLDAP replies all fit in a single datagram. In LDAPv2 RFC1798
858 * the responses are all a sequence wrapped in one message. In
859 * LDAPv3 each response is in its own message. The datagram must
860 * end with a SearchResult. We can't just parse each response in
861 * separate calls to try_read1msg because the header info is only
862 * present at the beginning of the datagram, not at the beginning
863 * of each response. So parse all the responses at once and queue
864 * them up, then pull off the first response to return to the
865 * caller when all parsing is complete.
867 if ( LDAP_IS_UDP(ld) ) {
868 /* If not a result, look for more */
869 if ( tag != LDAP_RES_SEARCH_RESULT ) {
873 /* LDAPv2: dup the current ber, skip past the current
874 * response, and see if there are any more after it.
876 ber = ber_dup( ber );
877 ber_scanf( ber, "x" );
878 if (ber_peek_tag(ber, &len) != LBER_DEFAULT) {
879 /* There's more - dup the ber buffer so they can all be
880 * individually freed by ldap_msgfree.
883 ber_get_option(ber, LBER_OPT_BER_REMAINING_BYTES, &len);
884 bv.bv_val = LDAP_MALLOC(len);
887 ber_read(ber, bv.bv_val, len);
889 ber_init2(ber, &bv, ld->ld_lberoptions );
893 /* LDAPv3: Just allocate a new ber. Since this is a buffered
894 * datagram, if the sockbuf is readable we still have data
897 ber = ldap_alloc_ber_with_options( ld );
898 if ( ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) ok = 1;
900 /* set up response chain */
902 newmsg->lm_next = ld->ld_responses;
903 ld->ld_responses = newmsg;
906 tmp->lm_chain = newmsg;
908 chain_head->lm_chain_tail = newmsg;
910 /* "ok" means there's more to parse */
912 if (isv2) goto nextresp2;
915 /* got to end of datagram without a SearchResult. Free
916 * our dup'd ber, but leave any buffer alone. For v2 case,
917 * the previous response is still using this buffer. For v3,
918 * the new ber has no buffer to free yet.
923 } else if ( moremsgs ) {
924 /* got search result, and we had multiple responses in 1 datagram.
925 * stick the result onto the end of the chain, and then pull the
926 * first response off the head of the chain.
928 tmp->lm_chain = newmsg;
929 chain_head->lm_chain_tail = newmsg;
930 *result = chkResponseList( ld, msgid, all );
931 ld->ld_errno = LDAP_SUCCESS;
932 return( (*result)->lm_msgtype );
935 #endif /* LDAP_CONNECTIONLESS */
937 /* is this the one we're looking for? */
938 if ( msgid == LDAP_RES_ANY || id == msgid ) {
939 if ( all == LDAP_MSG_ONE
940 || (newmsg->lm_msgtype != LDAP_RES_SEARCH_RESULT
941 && newmsg->lm_msgtype != LDAP_RES_SEARCH_ENTRY
942 && newmsg->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
944 ld->ld_errno = LDAP_SUCCESS;
946 } else if ( newmsg->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
947 foundit = 1; /* return the chain later */
952 * if not, we must add it to the list of responses. if
953 * the msgid is already there, it must be part of an existing
958 for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
959 if ( l->lm_msgid == newmsg->lm_msgid )
964 /* not part of an existing search response */
971 newmsg->lm_next = ld->ld_responses;
972 ld->ld_responses = newmsg;
976 Debug( LDAP_DEBUG_TRACE, "adding response ld %p msgid %ld type %ld:\n",
977 (void *)ld, (long) newmsg->lm_msgid, (long) newmsg->lm_msgtype );
979 /* part of a search response - add to end of list of entries */
980 l->lm_chain_tail->lm_chain = newmsg;
981 l->lm_chain_tail = newmsg;
983 /* return the whole chain if that's what we were looking for */
986 ld->ld_responses = l->lm_next;
988 prev->lm_next = l->lm_next;
994 ld->ld_errno = LDAP_SUCCESS;
997 if ( lc && ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
1000 return( LDAP_MSG_X_KEEP_LOOKING ); /* continue looking */
1005 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
1013 ber = ldap_alloc_ber_with_options( ld );
1016 ld->ld_errno = LDAP_NO_MEMORY;
1020 if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
1021 lr->lr_res_msgtype, lr->lr_res_errno,
1022 lr->lr_res_matched ? lr->lr_res_matched : "",
1023 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 )
1025 ld->ld_errno = LDAP_ENCODING_ERROR;
1027 return( LBER_ERROR );
1030 ber_reset( ber, 1 );
1032 if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
1033 ld->ld_errno = LDAP_DECODING_ERROR;
1035 return( LBER_ERROR );
1038 if ( ber_get_enum( ber, &along ) == LBER_ERROR ) {
1039 ld->ld_errno = LDAP_DECODING_ERROR;
1041 return( LBER_ERROR );
1044 tag = ber_peek_tag( ber, &len );
1046 if ( tag == LBER_ERROR ) {
1047 ld->ld_errno = LDAP_DECODING_ERROR;
1049 return( LBER_ERROR );
1058 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
1061 * Merge error information in "lr" with "parentr" error code and string.
1063 if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
1064 parentr->lr_res_errno = lr->lr_res_errno;
1065 if ( lr->lr_res_error != NULL ) {
1066 (void)ldap_append_referral( ld, &parentr->lr_res_error,
1069 } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
1070 parentr->lr_res_errno == LDAP_SUCCESS )
1072 parentr->lr_res_errno = lr->lr_res_errno;
1073 if ( parentr->lr_res_error != NULL ) {
1074 LDAP_FREE( parentr->lr_res_error );
1076 parentr->lr_res_error = lr->lr_res_error;
1077 lr->lr_res_error = NULL;
1078 if ( LDAP_NAME_ERROR( lr->lr_res_errno ) ) {
1079 if ( parentr->lr_res_matched != NULL ) {
1080 LDAP_FREE( parentr->lr_res_matched );
1082 parentr->lr_res_matched = lr->lr_res_matched;
1083 lr->lr_res_matched = NULL;
1087 Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info: ",
1088 parentr->lr_msgid, 0, 0 );
1089 Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
1090 parentr->lr_res_errno, parentr->lr_res_error ?
1091 parentr->lr_res_error : "", parentr->lr_res_matched ?
1092 parentr->lr_res_matched : "" );
1098 ldap_msgtype( LDAPMessage *lm )
1100 assert( lm != NULL );
1101 return ( lm != NULL ) ? (int)lm->lm_msgtype : -1;
1106 ldap_msgid( LDAPMessage *lm )
1108 assert( lm != NULL );
1110 return ( lm != NULL ) ? lm->lm_msgid : -1;
1114 char * ldap_int_msgtype2str( ber_tag_t tag )
1117 case LDAP_RES_ADD: return "add";
1118 case LDAP_RES_BIND: return "bind";
1119 case LDAP_RES_COMPARE: return "compare";
1120 case LDAP_RES_DELETE: return "delete";
1121 case LDAP_RES_EXTENDED: return "extended-result";
1122 case LDAP_RES_INTERMEDIATE: return "intermediate";
1123 case LDAP_RES_MODIFY: return "modify";
1124 case LDAP_RES_RENAME: return "rename";
1125 case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1126 case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1127 case LDAP_RES_SEARCH_RESULT: return "search-result";
1133 ldap_msgfree( LDAPMessage *lm )
1138 Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1140 for ( ; lm != NULL; lm = next ) {
1141 next = lm->lm_chain;
1142 type = lm->lm_msgtype;
1143 ber_free( lm->lm_ber, 1 );
1144 LDAP_FREE( (char *) lm );
1151 * ldap_msgdelete - delete a message. It returns:
1152 * 0 if the entire message was deleted
1153 * -1 if the message was not found, or only part of it was found
1156 ldap_msgdelete( LDAP *ld, int msgid )
1158 LDAPMessage *lm, *prev;
1161 assert( ld != NULL );
1163 Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1166 #ifdef LDAP_R_COMPILE
1167 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
1169 for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1170 if ( lm->lm_msgid == msgid )
1179 ld->ld_responses = lm->lm_next;
1181 prev->lm_next = lm->lm_next;
1183 #ifdef LDAP_R_COMPILE
1184 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
1186 if ( lm && ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1196 * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1198 * expects ld_res_mutex to be locked
1201 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1205 #ifdef LDAP_R_COMPILE
1206 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
1209 if ( ld->ld_abandoned == NULL )
1212 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1213 if ( ld->ld_abandoned[i] == msgid )
1221 * ldap_mark_abandoned
1223 * expects ld_res_mutex to be locked
1226 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1230 #ifdef LDAP_R_COMPILE
1231 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
1234 if ( ld->ld_abandoned == NULL )
1237 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1238 if ( ld->ld_abandoned[i] == msgid )
1241 if ( ld->ld_abandoned[i] == -1 )
1244 for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1245 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];