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; )
359 if ( lc->lconn_status == LDAP_CONNST_CONNECTED &&
360 ldap_is_read_ready( ld, lc->lconn_sb ) )
362 #ifdef LDAP_R_COMPILE
363 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
365 rc = try_read1msg( ld, msgid, all, &lc, result );
366 #ifdef LDAP_R_COMPILE
367 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
370 /* if lc gets free()'d,
371 * there's no guarantee
372 * lc->lconn_next is still
373 * sane; better restart
377 /* don't get to next conn! */
385 #ifdef LDAP_R_COMPILE
386 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
392 if ( rc == LDAP_MSG_X_KEEP_LOOKING && tvp != NULL ) {
393 tmp_time = time( NULL );
394 tv0.tv_sec -= ( tmp_time - start_time );
395 if ( tv0.tv_sec <= 0 ) {
396 rc = 0; /* timed out */
397 ld->ld_errno = LDAP_TIMEOUT;
400 tv.tv_sec = tv0.tv_sec;
402 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p %ld secs to go\n",
403 (void *)ld, (long) tv.tv_sec, 0 );
404 start_time = tmp_time;
418 LDAPMessage **result )
421 LDAPMessage *newmsg, *l, *prev;
426 LDAPRequest *lr, *tmplr;
429 int rc, refer_cnt, hadref, simple_request;
432 #ifdef LDAP_CONNECTIONLESS
433 LDAPMessage *tmp = NULL, *chain_head = NULL;
434 int moremsgs = 0, isv2 = 0;
438 * v3ref = flag for V3 referral / search reference
439 * 0 = not a ref, 1 = sucessfully chased ref, -1 = pass ref to application
447 assert( ld != NULL );
448 assert( lcp != NULL );
449 assert( *lcp != NULL );
451 #ifdef LDAP_R_COMPILE
452 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
455 Debug( LDAP_DEBUG_TRACE, "read1msg: ld %p msgid %d all %d\n",
456 (void *)ld, msgid, all );
461 if ( lc->lconn_ber == NULL ) {
462 lc->lconn_ber = ldap_alloc_ber_with_options( ld );
464 if( lc->lconn_ber == NULL ) {
470 assert( LBER_VALID (ber) );
472 /* get the next message */
474 #ifdef LDAP_CONNECTIONLESS
475 if ( LDAP_IS_UDP(ld) ) {
476 struct sockaddr from;
477 ber_int_sb_read( lc->lconn_sb, &from, sizeof(struct sockaddr) );
478 if (ld->ld_options.ldo_version == LDAP_VERSION2) isv2 = 1;
482 tag = ber_get_next( lc->lconn_sb, &len, ber );
484 case LDAP_TAG_MESSAGE:
486 * We read a complete message.
487 * The connection should no longer need this ber.
489 lc->lconn_ber = NULL;
494 Debug( LDAP_DEBUG_CONNS,
495 "ber_get_next failed.\n", 0, 0, 0 );
498 if ( errno == EWOULDBLOCK ) return LDAP_MSG_X_KEEP_LOOKING;
501 if ( errno == EAGAIN ) return LDAP_MSG_X_KEEP_LOOKING;
503 ld->ld_errno = LDAP_SERVER_DOWN;
507 ld->ld_errno = LDAP_LOCAL_ERROR;
512 if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
514 ld->ld_errno = LDAP_DECODING_ERROR;
518 /* if it's been abandoned, toss it */
519 if ( ldap_abandoned( ld, id ) ) {
520 Debug( LDAP_DEBUG_ANY, "abandoned ld %p msgid %ld\n",
521 (void *)ld, (long) id, 0);
524 if ( ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
527 return( LDAP_MSG_X_KEEP_LOOKING ); /* continue looking */
530 lr = ldap_find_request_by_msgid( ld, id );
532 Debug( LDAP_DEBUG_ANY,
533 "no request for response on ld %p msgid %ld (tossing)\n",
534 (void *)ld, (long)id, 0 );
537 #ifdef LDAP_CONNECTIONLESS
538 if (LDAP_IS_UDP(ld) && isv2) {
539 ber_scanf(ber, "x{");
543 /* the message type */
544 if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
545 ld->ld_errno = LDAP_DECODING_ERROR;
550 Debug( LDAP_DEBUG_TRACE,
551 "read1msg: ld %p msgid %ld message type %s\n",
552 (void *)ld, (long) lr->lr_msgid, ldap_int_msgtype2str( tag ));
556 hadref = simple_request = 0;
557 rc = LDAP_MSG_X_KEEP_LOOKING; /* default is to keep looking (no response found) */
558 lr->lr_res_msgtype = tag;
561 * This code figures out if we are going to chase a
562 * referral / search reference, or pass it back to the application
564 v3ref = V3REF_NOREF; /* Assume not a V3 search reference/referral */
565 if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
566 BerElement tmpber = *ber; /* struct copy */
569 if( tag == LDAP_RES_SEARCH_REFERENCE ) {
570 /* This is a V3 search reference */
571 /* Assume we do not chase the reference,
572 * but pass it to application */
574 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
575 (lr->lr_parent != NULL) )
577 /* Get the referral list */
578 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
579 rc = LDAP_DECODING_ERROR;
581 /* Note: refs array is freed by ldap_chase_v3referrals */
582 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
583 1, &lr->lr_res_error, &hadref );
584 if ( refer_cnt > 0 ) {
585 /* sucessfully chased reference */
586 /* If haven't got end search, set chasing referrals */
587 if ( lr->lr_status != LDAP_REQST_COMPLETED ) {
588 lr->lr_status = LDAP_REQST_CHASINGREFS;
589 Debug( LDAP_DEBUG_TRACE,
590 "read1msg: search ref chased, "
591 "mark request chasing refs, "
596 /* We sucessfully chased the reference */
597 v3ref = V3REF_SUCCESS;
602 /* Check for V3 referral */
604 char *lr_res_error = NULL;
606 if ( ber_scanf( &tmpber, "{eAA",/*}*/ &lderr,
607 &lr->lr_res_matched, &lr_res_error )
610 if ( lr_res_error != NULL ) {
612 if ( lr->lr_res_error != NULL ) {
613 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
614 LDAP_FREE( (char *)lr_res_error );
617 lr->lr_res_error = lr_res_error;
623 /* Check if V3 referral */
624 if ( ber_peek_tag( &tmpber, &len ) == LDAP_TAG_REFERRAL ) {
625 /* We have a V3 referral, assume we cannot chase it */
627 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
628 || (lr->lr_parent != NULL) )
630 /* Assume referral not chased and return it to app */
633 /* Get the referral list */
634 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
635 rc = LDAP_DECODING_ERROR;
636 lr->lr_status = LDAP_REQST_COMPLETED;
637 Debug( LDAP_DEBUG_TRACE,
638 "read1msg: referral decode error, mark request completed, ld %p msgid %d\n",
639 (void *)ld, lr->lr_msgid, 0);
641 /* Chase the referral
642 * Note: refs arrary is freed by ldap_chase_v3referrals
644 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
645 0, &lr->lr_res_error, &hadref );
646 lr->lr_status = LDAP_REQST_COMPLETED;
647 Debug( LDAP_DEBUG_TRACE,
648 "read1msg: referral chased, mark request completed, ld %p msgid %d\n",
649 (void *)ld, lr->lr_msgid, 0);
651 /* Referral successfully chased */
652 v3ref = V3REF_SUCCESS;
658 if( lr->lr_res_matched != NULL ) {
659 LDAP_FREE( lr->lr_res_matched );
660 lr->lr_res_matched = NULL;
662 if( lr->lr_res_error != NULL ) {
663 LDAP_FREE( lr->lr_res_error );
664 lr->lr_res_error = NULL;
670 /* All results that just return a status, i.e. don't return data
671 * go through the following code. This code also chases V2 referrals
672 * and checks if all referrals have been chased.
674 if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref != V3REF_TOAPP) &&
675 (tag != LDAP_RES_INTERMEDIATE ))
677 /* For a v3 search referral/reference, only come here if already chased it */
678 if ( ld->ld_version >= LDAP_VERSION2 &&
679 ( lr->lr_parent != NULL ||
680 LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
682 char *lr_res_error = NULL;
684 tmpber = *ber; /* struct copy */
685 if ( v3ref == V3REF_SUCCESS ) {
686 /* V3 search reference or V3 referral
687 * sucessfully chased. If this message
688 * is a search result, then it has no more
689 * outstanding referrals.
691 if ( tag == LDAP_RES_SEARCH_RESULT )
693 } else if ( ber_scanf( &tmpber, "{eAA}", &lderr,
694 &lr->lr_res_matched, &lr_res_error )
697 if ( lr_res_error != NULL ) {
698 if ( lr->lr_res_error != NULL ) {
699 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
700 LDAP_FREE( (char *)lr_res_error );
702 lr->lr_res_error = lr_res_error;
709 case LDAP_COMPARE_TRUE:
710 case LDAP_COMPARE_FALSE:
714 if ( lr->lr_res_error == NULL
715 || lr->lr_res_error[ 0 ] == '\0' )
720 /* referrals are in error string */
721 refer_cnt = ldap_chase_referrals( ld, lr,
722 &lr->lr_res_error, -1, &hadref );
723 lr->lr_status = LDAP_REQST_COMPLETED;
724 Debug( LDAP_DEBUG_TRACE,
725 "read1msg: V2 referral chased, "
726 "mark request completed, id = %d\n",
727 lr->lr_msgid, 0, 0 );
731 /* save errno, message, and matched string */
732 if ( !hadref || lr->lr_res_error == NULL ) {
733 lr->lr_res_errno = ( lderr ==
734 LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
736 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
737 lr->lr_res_errno = ld->ld_errno;
739 lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
742 Debug( LDAP_DEBUG_TRACE, "new result: "
745 "res_matched: <%s>\n",
747 lr->lr_res_error ? lr->lr_res_error : "",
748 lr->lr_res_matched ? lr->lr_res_matched : "" );
751 /* in any case, don't leave any lr_res_error 'round */
752 if ( lr_res_error ) {
753 LDAP_FREE( lr_res_error );
757 Debug( LDAP_DEBUG_TRACE,
758 "read1msg: ld %p %d new referrals\n",
759 (void *)ld, refer_cnt, 0 );
761 if ( refer_cnt != 0 ) { /* chasing referrals */
764 if ( refer_cnt < 0 ) {
765 return( -1 ); /* fatal error */
767 lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
769 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
770 /* request without any referrals */
771 simple_request = ( hadref ? 0 : 1 );
773 /* request with referrals or child request */
778 lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
779 Debug( LDAP_DEBUG_TRACE,
780 "read1msg: mark request completed, ld %p msgid %d\n",
781 (void *)ld, lr->lr_msgid, 0);
782 while ( lr->lr_parent != NULL ) {
783 merge_error_info( ld, lr->lr_parent, lr );
786 if ( --lr->lr_outrefcnt > 0 ) {
787 break; /* not completely done yet */
791 /* Check if all requests are finished, lr is now parent */
793 if ( tmplr->lr_status == LDAP_REQST_COMPLETED ) {
794 for ( tmplr=lr->lr_child;
796 tmplr=tmplr->lr_refnext)
798 if ( tmplr->lr_status != LDAP_REQST_COMPLETED ) break;
802 /* This is the parent request if the request has referrals */
803 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL &&
807 tag = lr->lr_res_msgtype;
808 Debug( LDAP_DEBUG_ANY, "request done: ld %p msgid %ld\n",
809 (void *)ld, (long) id, 0 );
810 Debug( LDAP_DEBUG_TRACE,
811 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
812 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
813 lr->lr_res_matched ? lr->lr_res_matched : "" );
814 if ( !simple_request ) {
817 if ( build_result_ber( ld, &ber, lr )
820 rc = -1; /* fatal error */
824 #ifdef LDAP_R_COMPILE
825 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
827 ldap_free_request( ld, lr );
828 #ifdef LDAP_R_COMPILE
829 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
834 #ifdef LDAP_R_COMPILE
835 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
837 ldap_free_connection( ld, lc, 0, 1 );
838 #ifdef LDAP_R_COMPILE
839 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
850 /* make a new ldap message */
851 newmsg = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) );
852 if ( newmsg == NULL ) {
853 ld->ld_errno = LDAP_NO_MEMORY;
856 newmsg->lm_msgid = (int)id;
857 newmsg->lm_msgtype = tag;
858 newmsg->lm_ber = ber;
859 newmsg->lm_chain_tail = newmsg;
861 #ifdef LDAP_CONNECTIONLESS
862 /* CLDAP replies all fit in a single datagram. In LDAPv2 RFC1798
863 * the responses are all a sequence wrapped in one message. In
864 * LDAPv3 each response is in its own message. The datagram must
865 * end with a SearchResult. We can't just parse each response in
866 * separate calls to try_read1msg because the header info is only
867 * present at the beginning of the datagram, not at the beginning
868 * of each response. So parse all the responses at once and queue
869 * them up, then pull off the first response to return to the
870 * caller when all parsing is complete.
872 if ( LDAP_IS_UDP(ld) ) {
873 /* If not a result, look for more */
874 if ( tag != LDAP_RES_SEARCH_RESULT ) {
878 /* LDAPv2: dup the current ber, skip past the current
879 * response, and see if there are any more after it.
881 ber = ber_dup( ber );
882 ber_scanf( ber, "x" );
883 if (ber_peek_tag(ber, &len) != LBER_DEFAULT) {
884 /* There's more - dup the ber buffer so they can all be
885 * individually freed by ldap_msgfree.
888 ber_get_option(ber, LBER_OPT_BER_REMAINING_BYTES, &len);
889 bv.bv_val = LDAP_MALLOC(len);
892 ber_read(ber, bv.bv_val, len);
894 ber_init2(ber, &bv, ld->ld_lberoptions );
898 /* LDAPv3: Just allocate a new ber. Since this is a buffered
899 * datagram, if the sockbuf is readable we still have data
902 ber = ldap_alloc_ber_with_options( ld );
903 if ( ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) ok = 1;
905 /* set up response chain */
907 newmsg->lm_next = ld->ld_responses;
908 ld->ld_responses = newmsg;
911 tmp->lm_chain = newmsg;
913 chain_head->lm_chain_tail = newmsg;
915 /* "ok" means there's more to parse */
917 if (isv2) goto nextresp2;
920 /* got to end of datagram without a SearchResult. Free
921 * our dup'd ber, but leave any buffer alone. For v2 case,
922 * the previous response is still using this buffer. For v3,
923 * the new ber has no buffer to free yet.
928 } else if ( moremsgs ) {
929 /* got search result, and we had multiple responses in 1 datagram.
930 * stick the result onto the end of the chain, and then pull the
931 * first response off the head of the chain.
933 tmp->lm_chain = newmsg;
934 chain_head->lm_chain_tail = newmsg;
935 *result = chkResponseList( ld, msgid, all );
936 ld->ld_errno = LDAP_SUCCESS;
937 return( (*result)->lm_msgtype );
940 #endif /* LDAP_CONNECTIONLESS */
942 /* is this the one we're looking for? */
943 if ( msgid == LDAP_RES_ANY || id == msgid ) {
944 if ( all == LDAP_MSG_ONE
945 || (newmsg->lm_msgtype != LDAP_RES_SEARCH_RESULT
946 && newmsg->lm_msgtype != LDAP_RES_SEARCH_ENTRY
947 && newmsg->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
949 ld->ld_errno = LDAP_SUCCESS;
951 } else if ( newmsg->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
952 foundit = 1; /* return the chain later */
957 * if not, we must add it to the list of responses. if
958 * the msgid is already there, it must be part of an existing
963 for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
964 if ( l->lm_msgid == newmsg->lm_msgid )
969 /* not part of an existing search response */
976 newmsg->lm_next = ld->ld_responses;
977 ld->ld_responses = newmsg;
981 Debug( LDAP_DEBUG_TRACE, "adding response ld %p msgid %ld type %ld:\n",
982 (void *)ld, (long) newmsg->lm_msgid, (long) newmsg->lm_msgtype );
984 /* part of a search response - add to end of list of entries */
985 l->lm_chain_tail->lm_chain = newmsg;
986 l->lm_chain_tail = newmsg;
988 /* return the whole chain if that's what we were looking for */
991 ld->ld_responses = l->lm_next;
993 prev->lm_next = l->lm_next;
999 ld->ld_errno = LDAP_SUCCESS;
1002 if ( lc && ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
1005 return( LDAP_MSG_X_KEEP_LOOKING ); /* continue looking */
1010 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
1018 ber = ldap_alloc_ber_with_options( ld );
1021 ld->ld_errno = LDAP_NO_MEMORY;
1025 if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
1026 lr->lr_res_msgtype, lr->lr_res_errno,
1027 lr->lr_res_matched ? lr->lr_res_matched : "",
1028 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 )
1030 ld->ld_errno = LDAP_ENCODING_ERROR;
1032 return( LBER_ERROR );
1035 ber_reset( ber, 1 );
1037 if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
1038 ld->ld_errno = LDAP_DECODING_ERROR;
1040 return( LBER_ERROR );
1043 if ( ber_get_enum( ber, &along ) == LBER_ERROR ) {
1044 ld->ld_errno = LDAP_DECODING_ERROR;
1046 return( LBER_ERROR );
1049 tag = ber_peek_tag( ber, &len );
1051 if ( tag == LBER_ERROR ) {
1052 ld->ld_errno = LDAP_DECODING_ERROR;
1054 return( LBER_ERROR );
1063 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
1066 * Merge error information in "lr" with "parentr" error code and string.
1068 if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
1069 parentr->lr_res_errno = lr->lr_res_errno;
1070 if ( lr->lr_res_error != NULL ) {
1071 (void)ldap_append_referral( ld, &parentr->lr_res_error,
1074 } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
1075 parentr->lr_res_errno == LDAP_SUCCESS )
1077 parentr->lr_res_errno = lr->lr_res_errno;
1078 if ( parentr->lr_res_error != NULL ) {
1079 LDAP_FREE( parentr->lr_res_error );
1081 parentr->lr_res_error = lr->lr_res_error;
1082 lr->lr_res_error = NULL;
1083 if ( LDAP_NAME_ERROR( lr->lr_res_errno ) ) {
1084 if ( parentr->lr_res_matched != NULL ) {
1085 LDAP_FREE( parentr->lr_res_matched );
1087 parentr->lr_res_matched = lr->lr_res_matched;
1088 lr->lr_res_matched = NULL;
1092 Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info: ",
1093 parentr->lr_msgid, 0, 0 );
1094 Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
1095 parentr->lr_res_errno, parentr->lr_res_error ?
1096 parentr->lr_res_error : "", parentr->lr_res_matched ?
1097 parentr->lr_res_matched : "" );
1103 ldap_msgtype( LDAPMessage *lm )
1105 assert( lm != NULL );
1106 return ( lm != NULL ) ? (int)lm->lm_msgtype : -1;
1111 ldap_msgid( LDAPMessage *lm )
1113 assert( lm != NULL );
1115 return ( lm != NULL ) ? lm->lm_msgid : -1;
1119 char * ldap_int_msgtype2str( ber_tag_t tag )
1122 case LDAP_RES_ADD: return "add";
1123 case LDAP_RES_BIND: return "bind";
1124 case LDAP_RES_COMPARE: return "compare";
1125 case LDAP_RES_DELETE: return "delete";
1126 case LDAP_RES_EXTENDED: return "extended-result";
1127 case LDAP_RES_INTERMEDIATE: return "intermediate";
1128 case LDAP_RES_MODIFY: return "modify";
1129 case LDAP_RES_RENAME: return "rename";
1130 case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1131 case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1132 case LDAP_RES_SEARCH_RESULT: return "search-result";
1138 ldap_msgfree( LDAPMessage *lm )
1143 Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1145 for ( ; lm != NULL; lm = next ) {
1146 next = lm->lm_chain;
1147 type = lm->lm_msgtype;
1148 ber_free( lm->lm_ber, 1 );
1149 LDAP_FREE( (char *) lm );
1156 * ldap_msgdelete - delete a message. It returns:
1157 * 0 if the entire message was deleted
1158 * -1 if the message was not found, or only part of it was found
1161 ldap_msgdelete( LDAP *ld, int msgid )
1163 LDAPMessage *lm, *prev;
1166 assert( ld != NULL );
1168 Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1171 #ifdef LDAP_R_COMPILE
1172 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
1174 for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1175 if ( lm->lm_msgid == msgid )
1184 ld->ld_responses = lm->lm_next;
1186 prev->lm_next = lm->lm_next;
1188 #ifdef LDAP_R_COMPILE
1189 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
1191 if ( lm && ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1201 * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1203 * expects ld_res_mutex to be locked
1206 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1210 #ifdef LDAP_R_COMPILE
1211 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
1214 if ( ld->ld_abandoned == NULL )
1217 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1218 if ( ld->ld_abandoned[i] == msgid )
1226 * ldap_mark_abandoned
1228 * expects ld_res_mutex to be locked
1231 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1235 #ifdef LDAP_R_COMPILE
1236 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
1239 if ( ld->ld_abandoned == NULL )
1242 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1243 if ( ld->ld_abandoned[i] == msgid )
1246 if ( ld->ld_abandoned[i] == -1 )
1249 for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1250 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];