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 (1997)
41 * ASN.1 fragments are from RFC 2251; see RFC for full legal notices.
46 * LDAPResult ::= SEQUENCE {
47 * resultCode ENUMERATED { ... },
49 * errorMessage LDAPString,
50 * referral 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;
242 LDAPConn *lc, *nextlc;
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 ldap_dump_connection( ld, ld->ld_conns, 1 );
277 ldap_dump_requests_and_responses( ld );
279 #endif /* LDAP_DEBUG */
281 if ( ( *result = chkResponseList( ld, msgid, all ) ) != NULL ) {
282 rc = (*result)->lm_msgtype;
287 #ifdef LDAP_R_COMPILE
288 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
290 for ( lc = ld->ld_conns; lc != NULL; lc = nextlc ) {
291 nextlc = lc->lconn_next;
292 if ( ber_sockbuf_ctrl( lc->lconn_sb,
293 LBER_SB_OPT_DATA_READY, NULL ) )
295 #ifdef LDAP_R_COMPILE
296 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
298 rc = try_read1msg( ld, msgid, all, &lc, result );
299 #ifdef LDAP_R_COMPILE
300 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
306 #ifdef LDAP_R_COMPILE
307 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
311 rc = ldap_int_select( ld, tvp );
314 Debug( LDAP_DEBUG_TRACE,
315 "ldap_int_select returned -1: errno %d\n",
320 if ( rc == 0 || ( rc == -1 && (
321 !LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_RESTART)
322 || errno != EINTR ) ) )
324 ld->ld_errno = (rc == -1 ? LDAP_SERVER_DOWN :
330 rc = LDAP_MSG_X_KEEP_LOOKING; /* select interrupted: loop */
332 rc = LDAP_MSG_X_KEEP_LOOKING;
333 #ifdef LDAP_R_COMPILE
334 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
336 if ( ld->ld_requests &&
337 ld->ld_requests->lr_status == LDAP_REQST_WRITING &&
338 ldap_is_write_ready( ld,
339 ld->ld_requests->lr_conn->lconn_sb ) )
341 ldap_int_flush_request( ld, ld->ld_requests );
343 #ifdef LDAP_R_COMPILE
344 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
345 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
347 for ( lc = ld->ld_conns; rc == LDAP_MSG_X_KEEP_LOOKING && lc != NULL;
350 nextlc = lc->lconn_next;
351 if ( lc->lconn_status == LDAP_CONNST_CONNECTED &&
352 ldap_is_read_ready( ld, lc->lconn_sb ) )
354 #ifdef LDAP_R_COMPILE
355 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
357 rc = try_read1msg( ld, msgid, all, &lc, result );
358 if ( lc == NULL ) lc = nextlc;
359 #ifdef LDAP_R_COMPILE
360 ldap_pvt_thread_mutex_lock( &ld->ld_conn_mutex );
364 #ifdef LDAP_R_COMPILE
365 ldap_pvt_thread_mutex_unlock( &ld->ld_conn_mutex );
371 if ( rc == LDAP_MSG_X_KEEP_LOOKING && tvp != NULL ) {
372 tmp_time = time( NULL );
373 tv0.tv_sec -= ( tmp_time - start_time );
374 if ( tv0.tv_sec <= 0 ) {
375 rc = 0; /* timed out */
376 ld->ld_errno = LDAP_TIMEOUT;
379 tv.tv_sec = tv0.tv_sec;
381 Debug( LDAP_DEBUG_TRACE, "wait4msg ld %p %ld secs to go\n",
382 (void *)ld, (long) tv.tv_sec, 0 );
383 start_time = tmp_time;
397 LDAPMessage **result )
400 LDAPMessage *newmsg, *l, *prev;
405 LDAPRequest *lr, *tmplr;
408 int rc, refer_cnt, hadref, simple_request;
411 #ifdef LDAP_CONNECTIONLESS
412 LDAPMessage *tmp = NULL, *chain_head = NULL;
413 int moremsgs = 0, isv2 = 0;
417 * v3ref = flag for V3 referral / search reference
418 * 0 = not a ref, 1 = sucessfully chased ref, -1 = pass ref to application
426 assert( ld != NULL );
427 assert( lcp != NULL );
428 assert( *lcp != NULL );
430 #ifdef LDAP_R_COMPILE
431 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
434 Debug( LDAP_DEBUG_TRACE, "read1msg: ld %p msgid %d all %d\n",
435 (void *)ld, msgid, all );
440 if ( lc->lconn_ber == NULL ) {
441 lc->lconn_ber = ldap_alloc_ber_with_options( ld );
443 if( lc->lconn_ber == NULL ) {
449 assert( LBER_VALID (ber) );
451 /* get the next message */
453 #ifdef LDAP_CONNECTIONLESS
454 if ( LDAP_IS_UDP(ld) ) {
455 struct sockaddr from;
456 ber_int_sb_read( lc->lconn_sb, &from, sizeof(struct sockaddr) );
457 if (ld->ld_options.ldo_version == LDAP_VERSION2) isv2 = 1;
461 tag = ber_get_next( lc->lconn_sb, &len, ber );
463 case LDAP_TAG_MESSAGE:
465 * We read a complete message.
466 * The connection should no longer need this ber.
468 lc->lconn_ber = NULL;
473 Debug( LDAP_DEBUG_CONNS,
474 "ber_get_next failed.\n", 0, 0, 0 );
477 if ( errno == EWOULDBLOCK ) return LDAP_MSG_X_KEEP_LOOKING;
480 if ( errno == EAGAIN ) return LDAP_MSG_X_KEEP_LOOKING;
482 ld->ld_errno = LDAP_SERVER_DOWN;
486 ld->ld_errno = LDAP_LOCAL_ERROR;
491 if ( ber_get_int( ber, &id ) == LBER_ERROR ) {
493 ld->ld_errno = LDAP_DECODING_ERROR;
497 /* if it's been abandoned, toss it */
498 if ( ldap_abandoned( ld, id ) ) {
499 Debug( LDAP_DEBUG_ANY, "abandoned ld %p msgid %ld\n",
500 (void *)ld, (long) id, 0);
503 if ( ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
506 return( LDAP_MSG_X_KEEP_LOOKING ); /* continue looking */
509 lr = ldap_find_request_by_msgid( ld, id );
511 Debug( LDAP_DEBUG_ANY,
512 "no request for response on ld %p msgid %ld (tossing)\n",
513 (void *)ld, (long)id, 0 );
516 #ifdef LDAP_CONNECTIONLESS
517 if (LDAP_IS_UDP(ld) && isv2) {
518 ber_scanf(ber, "x{");
522 /* the message type */
523 if ( (tag = ber_peek_tag( ber, &len )) == LBER_ERROR ) {
524 ld->ld_errno = LDAP_DECODING_ERROR;
529 Debug( LDAP_DEBUG_TRACE,
530 "read1msg: ld %p msgid %ld message type %s\n",
531 (void *)ld, (long) lr->lr_msgid, ldap_int_msgtype2str( tag ));
535 hadref = simple_request = 0;
536 rc = LDAP_MSG_X_KEEP_LOOKING; /* default is to keep looking (no response found) */
537 lr->lr_res_msgtype = tag;
540 * This code figures out if we are going to chase a
541 * referral / search reference, or pass it back to the application
543 v3ref = V3REF_NOREF; /* Assume not a V3 search reference/referral */
544 if( (tag != LDAP_RES_SEARCH_ENTRY) && (ld->ld_version > LDAP_VERSION2) ) {
545 BerElement tmpber = *ber; /* struct copy */
548 if( tag == LDAP_RES_SEARCH_REFERENCE ) {
549 /* This is a V3 search reference */
550 /* Assume we do not chase the reference,
551 * but pass it to application */
553 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ||
554 (lr->lr_parent != NULL) )
556 /* Get the referral list */
557 if ( ber_scanf( &tmpber, "{v}", &refs ) == LBER_ERROR ) {
558 rc = LDAP_DECODING_ERROR;
560 /* Note: refs array is freed by ldap_chase_v3referrals */
561 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
562 1, &lr->lr_res_error, &hadref );
563 if ( refer_cnt > 0 ) {
564 /* sucessfully chased reference */
565 /* If haven't got end search, set chasing referrals */
566 if ( lr->lr_status != LDAP_REQST_COMPLETED ) {
567 lr->lr_status = LDAP_REQST_CHASINGREFS;
568 Debug( LDAP_DEBUG_TRACE,
569 "read1msg: search ref chased, "
570 "mark request chasing refs, "
575 /* We sucessfully chased the reference */
576 v3ref = V3REF_SUCCESS;
581 /* Check for V3 referral */
583 char *lr_res_error = NULL;
585 if ( ber_scanf( &tmpber, "{eAA",/*}*/ &lderr,
586 &lr->lr_res_matched, &lr_res_error )
589 if ( lr_res_error != NULL ) {
591 if ( lr->lr_res_error != NULL ) {
592 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
593 LDAP_FREE( (char *)lr_res_error );
596 lr->lr_res_error = lr_res_error;
602 /* Check if V3 referral */
603 if ( ber_peek_tag( &tmpber, &len ) == LDAP_TAG_REFERRAL ) {
604 /* We have a V3 referral, assume we cannot chase it */
606 if( LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS)
607 || (lr->lr_parent != NULL) )
609 /* Assume referral not chased and return it to app */
612 /* Get the referral list */
613 if( ber_scanf( &tmpber, "{v}", &refs) == LBER_ERROR) {
614 rc = LDAP_DECODING_ERROR;
615 lr->lr_status = LDAP_REQST_COMPLETED;
616 Debug( LDAP_DEBUG_TRACE,
617 "read1msg: referral decode error, mark request completed, ld %p msgid %d\n",
618 (void *)ld, lr->lr_msgid, 0);
620 /* Chase the referral
621 * Note: refs arrary is freed by ldap_chase_v3referrals
623 refer_cnt = ldap_chase_v3referrals( ld, lr, refs,
624 0, &lr->lr_res_error, &hadref );
625 lr->lr_status = LDAP_REQST_COMPLETED;
626 Debug( LDAP_DEBUG_TRACE,
627 "read1msg: referral chased, mark request completed, ld %p msgid %d\n",
628 (void *)ld, lr->lr_msgid, 0);
630 /* Referral successfully chased */
631 v3ref = V3REF_SUCCESS;
637 if( lr->lr_res_matched != NULL ) {
638 LDAP_FREE( lr->lr_res_matched );
639 lr->lr_res_matched = NULL;
641 if( lr->lr_res_error != NULL ) {
642 LDAP_FREE( lr->lr_res_error );
643 lr->lr_res_error = NULL;
649 /* All results that just return a status, i.e. don't return data
650 * go through the following code. This code also chases V2 referrals
651 * and checks if all referrals have been chased.
653 if ( (tag != LDAP_RES_SEARCH_ENTRY) && (v3ref != V3REF_TOAPP) &&
654 (tag != LDAP_RES_INTERMEDIATE ))
656 /* For a v3 search referral/reference, only come here if already chased it */
657 if ( ld->ld_version >= LDAP_VERSION2 &&
658 ( lr->lr_parent != NULL ||
659 LDAP_BOOL_GET(&ld->ld_options, LDAP_BOOL_REFERRALS) ) )
661 char *lr_res_error = NULL;
663 tmpber = *ber; /* struct copy */
664 if ( v3ref == V3REF_SUCCESS ) {
665 /* V3 search reference or V3 referral
666 * sucessfully chased. If this message
667 * is a search result, then it has no more
668 * outstanding referrals.
670 if ( tag == LDAP_RES_SEARCH_RESULT )
672 } else if ( ber_scanf( &tmpber, "{eAA}", &lderr,
673 &lr->lr_res_matched, &lr_res_error )
676 if ( lr_res_error != NULL ) {
677 if ( lr->lr_res_error != NULL ) {
678 (void)ldap_append_referral( ld, &lr->lr_res_error, lr_res_error );
679 LDAP_FREE( (char *)lr_res_error );
681 lr->lr_res_error = lr_res_error;
688 case LDAP_COMPARE_TRUE:
689 case LDAP_COMPARE_FALSE:
693 if ( lr->lr_res_error == NULL
694 || lr->lr_res_error[ 0 ] == '\0' )
699 /* referrals are in error string */
700 refer_cnt = ldap_chase_referrals( ld, lr,
701 &lr->lr_res_error, -1, &hadref );
702 lr->lr_status = LDAP_REQST_COMPLETED;
703 Debug( LDAP_DEBUG_TRACE,
704 "read1msg: V2 referral chased, "
705 "mark request completed, id = %d\n",
706 lr->lr_msgid, 0, 0 );
710 /* save errno, message, and matched string */
711 if ( !hadref || lr->lr_res_error == NULL ) {
712 lr->lr_res_errno = ( lderr ==
713 LDAP_PARTIAL_RESULTS ) ? LDAP_SUCCESS
715 } else if ( ld->ld_errno != LDAP_SUCCESS ) {
716 lr->lr_res_errno = ld->ld_errno;
718 lr->lr_res_errno = LDAP_PARTIAL_RESULTS;
721 Debug( LDAP_DEBUG_TRACE, "new result: "
724 "res_matched: <%s>\n",
726 lr->lr_res_error ? lr->lr_res_error : "",
727 lr->lr_res_matched ? lr->lr_res_matched : "" );
730 /* in any case, don't leave any lr_res_error 'round */
731 if ( lr_res_error ) {
732 LDAP_FREE( lr_res_error );
736 Debug( LDAP_DEBUG_TRACE,
737 "read1msg: ld %p %d new referrals\n",
738 (void *)ld, refer_cnt, 0 );
740 if ( refer_cnt != 0 ) { /* chasing referrals */
743 if ( refer_cnt < 0 ) {
744 return( -1 ); /* fatal error */
746 lr->lr_res_errno = LDAP_SUCCESS; /* sucessfully chased referral */
748 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL ) {
749 /* request without any referrals */
750 simple_request = ( hadref ? 0 : 1 );
752 /* request with referrals or child request */
757 lr->lr_status = LDAP_REQST_COMPLETED; /* declare this request done */
758 Debug( LDAP_DEBUG_TRACE,
759 "read1msg: mark request completed, ld %p msgid %d\n",
760 (void *)ld, lr->lr_msgid, 0);
761 while ( lr->lr_parent != NULL ) {
762 merge_error_info( ld, lr->lr_parent, lr );
765 if ( --lr->lr_outrefcnt > 0 ) {
766 break; /* not completely done yet */
770 /* Check if all requests are finished, lr is now parent */
772 if ( tmplr->lr_status == LDAP_REQST_COMPLETED ) {
773 for ( tmplr=lr->lr_child;
775 tmplr=tmplr->lr_refnext)
777 if ( tmplr->lr_status != LDAP_REQST_COMPLETED ) break;
781 /* This is the parent request if the request has referrals */
782 if ( lr->lr_outrefcnt <= 0 && lr->lr_parent == NULL &&
786 tag = lr->lr_res_msgtype;
787 Debug( LDAP_DEBUG_ANY, "request done: ld %p msgid %ld\n",
788 (void *)ld, (long) id, 0 );
789 Debug( LDAP_DEBUG_TRACE,
790 "res_errno: %d, res_error: <%s>, res_matched: <%s>\n",
791 lr->lr_res_errno, lr->lr_res_error ? lr->lr_res_error : "",
792 lr->lr_res_matched ? lr->lr_res_matched : "" );
793 if ( !simple_request ) {
796 if ( build_result_ber( ld, &ber, lr )
799 rc = -1; /* fatal error */
803 #ifdef LDAP_R_COMPILE
804 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
806 ldap_free_request( ld, lr );
807 #ifdef LDAP_R_COMPILE
808 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
813 #ifdef LDAP_R_COMPILE
814 ldap_pvt_thread_mutex_lock( &ld->ld_req_mutex );
816 ldap_free_connection( ld, lc, 0, 1 );
817 #ifdef LDAP_R_COMPILE
818 ldap_pvt_thread_mutex_unlock( &ld->ld_req_mutex );
829 /* make a new ldap message */
830 newmsg = (LDAPMessage *) LDAP_CALLOC( 1, sizeof(LDAPMessage) );
831 if ( newmsg == NULL ) {
832 ld->ld_errno = LDAP_NO_MEMORY;
835 newmsg->lm_msgid = (int)id;
836 newmsg->lm_msgtype = tag;
837 newmsg->lm_ber = ber;
838 newmsg->lm_chain_tail = newmsg;
840 #ifdef LDAP_CONNECTIONLESS
841 /* CLDAP replies all fit in a single datagram. In LDAPv2 RFC1798
842 * the responses are all a sequence wrapped in one message. In
843 * LDAPv3 each response is in its own message. The datagram must
844 * end with a SearchResult. We can't just parse each response in
845 * separate calls to try_read1msg because the header info is only
846 * present at the beginning of the datagram, not at the beginning
847 * of each response. So parse all the responses at once and queue
848 * them up, then pull off the first response to return to the
849 * caller when all parsing is complete.
851 if ( LDAP_IS_UDP(ld) ) {
852 /* If not a result, look for more */
853 if ( tag != LDAP_RES_SEARCH_RESULT ) {
857 /* LDAPv2: dup the current ber, skip past the current
858 * response, and see if there are any more after it.
860 ber = ber_dup( ber );
861 ber_scanf( ber, "x" );
862 if (ber_peek_tag(ber, &len) != LBER_DEFAULT) {
863 /* There's more - dup the ber buffer so they can all be
864 * individually freed by ldap_msgfree.
867 ber_get_option(ber, LBER_OPT_BER_REMAINING_BYTES, &len);
868 bv.bv_val = LDAP_MALLOC(len);
871 ber_read(ber, bv.bv_val, len);
873 ber_init2(ber, &bv, ld->ld_lberoptions );
877 /* LDAPv3: Just allocate a new ber. Since this is a buffered
878 * datagram, if the sockbuf is readable we still have data
881 ber = ldap_alloc_ber_with_options( ld );
882 if ( ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) ok = 1;
884 /* set up response chain */
886 newmsg->lm_next = ld->ld_responses;
887 ld->ld_responses = newmsg;
890 tmp->lm_chain = newmsg;
892 chain_head->lm_chain_tail = newmsg;
894 /* "ok" means there's more to parse */
896 if (isv2) goto nextresp2;
899 /* got to end of datagram without a SearchResult. Free
900 * our dup'd ber, but leave any buffer alone. For v2 case,
901 * the previous response is still using this buffer. For v3,
902 * the new ber has no buffer to free yet.
907 } else if ( moremsgs ) {
908 /* got search result, and we had multiple responses in 1 datagram.
909 * stick the result onto the end of the chain, and then pull the
910 * first response off the head of the chain.
912 tmp->lm_chain = newmsg;
913 chain_head->lm_chain_tail = newmsg;
914 *result = chkResponseList( ld, msgid, all );
915 ld->ld_errno = LDAP_SUCCESS;
916 return( (*result)->lm_msgtype );
919 #endif /* LDAP_CONNECTIONLESS */
921 /* is this the one we're looking for? */
922 if ( msgid == LDAP_RES_ANY || id == msgid ) {
923 if ( all == LDAP_MSG_ONE
924 || (newmsg->lm_msgtype != LDAP_RES_SEARCH_RESULT
925 && newmsg->lm_msgtype != LDAP_RES_SEARCH_ENTRY
926 && newmsg->lm_msgtype != LDAP_RES_SEARCH_REFERENCE) ) {
928 ld->ld_errno = LDAP_SUCCESS;
930 } else if ( newmsg->lm_msgtype == LDAP_RES_SEARCH_RESULT) {
931 foundit = 1; /* return the chain later */
936 * if not, we must add it to the list of responses. if
937 * the msgid is already there, it must be part of an existing
942 for ( l = ld->ld_responses; l != NULL; l = l->lm_next ) {
943 if ( l->lm_msgid == newmsg->lm_msgid )
948 /* not part of an existing search response */
955 newmsg->lm_next = ld->ld_responses;
956 ld->ld_responses = newmsg;
960 Debug( LDAP_DEBUG_TRACE, "adding response ld %p msgid %ld type %ld:\n",
961 (void *)ld, (long) newmsg->lm_msgid, (long) newmsg->lm_msgtype );
963 /* part of a search response - add to end of list of entries */
964 l->lm_chain_tail->lm_chain = newmsg;
965 l->lm_chain_tail = newmsg;
967 /* return the whole chain if that's what we were looking for */
970 ld->ld_responses = l->lm_next;
972 prev->lm_next = l->lm_next;
978 ld->ld_errno = LDAP_SUCCESS;
981 if ( lc && ber_sockbuf_ctrl( lc->lconn_sb, LBER_SB_OPT_DATA_READY, NULL ) ) {
984 return( LDAP_MSG_X_KEEP_LOOKING ); /* continue looking */
989 build_result_ber( LDAP *ld, BerElement **bp, LDAPRequest *lr )
997 ber = ldap_alloc_ber_with_options( ld );
1000 ld->ld_errno = LDAP_NO_MEMORY;
1004 if ( ber_printf( ber, "{it{ess}}", lr->lr_msgid,
1005 lr->lr_res_msgtype, lr->lr_res_errno,
1006 lr->lr_res_matched ? lr->lr_res_matched : "",
1007 lr->lr_res_error ? lr->lr_res_error : "" ) == -1 )
1009 ld->ld_errno = LDAP_ENCODING_ERROR;
1011 return( LBER_ERROR );
1014 ber_reset( ber, 1 );
1016 if ( ber_skip_tag( ber, &len ) == LBER_ERROR ) {
1017 ld->ld_errno = LDAP_DECODING_ERROR;
1019 return( LBER_ERROR );
1022 if ( ber_get_enum( ber, &along ) == LBER_ERROR ) {
1023 ld->ld_errno = LDAP_DECODING_ERROR;
1025 return( LBER_ERROR );
1028 tag = ber_peek_tag( ber, &len );
1030 if ( tag == LBER_ERROR ) {
1031 ld->ld_errno = LDAP_DECODING_ERROR;
1033 return( LBER_ERROR );
1042 merge_error_info( LDAP *ld, LDAPRequest *parentr, LDAPRequest *lr )
1045 * Merge error information in "lr" with "parentr" error code and string.
1047 if ( lr->lr_res_errno == LDAP_PARTIAL_RESULTS ) {
1048 parentr->lr_res_errno = lr->lr_res_errno;
1049 if ( lr->lr_res_error != NULL ) {
1050 (void)ldap_append_referral( ld, &parentr->lr_res_error,
1053 } else if ( lr->lr_res_errno != LDAP_SUCCESS &&
1054 parentr->lr_res_errno == LDAP_SUCCESS )
1056 parentr->lr_res_errno = lr->lr_res_errno;
1057 if ( parentr->lr_res_error != NULL ) {
1058 LDAP_FREE( parentr->lr_res_error );
1060 parentr->lr_res_error = lr->lr_res_error;
1061 lr->lr_res_error = NULL;
1062 if ( LDAP_NAME_ERROR( lr->lr_res_errno ) ) {
1063 if ( parentr->lr_res_matched != NULL ) {
1064 LDAP_FREE( parentr->lr_res_matched );
1066 parentr->lr_res_matched = lr->lr_res_matched;
1067 lr->lr_res_matched = NULL;
1071 Debug( LDAP_DEBUG_TRACE, "merged parent (id %d) error info: ",
1072 parentr->lr_msgid, 0, 0 );
1073 Debug( LDAP_DEBUG_TRACE, "result errno %d, error <%s>, matched <%s>\n",
1074 parentr->lr_res_errno, parentr->lr_res_error ?
1075 parentr->lr_res_error : "", parentr->lr_res_matched ?
1076 parentr->lr_res_matched : "" );
1082 ldap_msgtype( LDAPMessage *lm )
1084 assert( lm != NULL );
1085 return ( lm != NULL ) ? (int)lm->lm_msgtype : -1;
1090 ldap_msgid( LDAPMessage *lm )
1092 assert( lm != NULL );
1094 return ( lm != NULL ) ? lm->lm_msgid : -1;
1098 char * ldap_int_msgtype2str( ber_tag_t tag )
1101 case LDAP_RES_ADD: return "add";
1102 case LDAP_RES_BIND: return "bind";
1103 case LDAP_RES_COMPARE: return "compare";
1104 case LDAP_RES_DELETE: return "delete";
1105 case LDAP_RES_EXTENDED: return "extended-result";
1106 case LDAP_RES_INTERMEDIATE: return "intermediate";
1107 case LDAP_RES_MODIFY: return "modify";
1108 case LDAP_RES_RENAME: return "rename";
1109 case LDAP_RES_SEARCH_ENTRY: return "search-entry";
1110 case LDAP_RES_SEARCH_REFERENCE: return "search-reference";
1111 case LDAP_RES_SEARCH_RESULT: return "search-result";
1117 ldap_msgfree( LDAPMessage *lm )
1122 Debug( LDAP_DEBUG_TRACE, "ldap_msgfree\n", 0, 0, 0 );
1124 for ( ; lm != NULL; lm = next ) {
1125 next = lm->lm_chain;
1126 type = lm->lm_msgtype;
1127 ber_free( lm->lm_ber, 1 );
1128 LDAP_FREE( (char *) lm );
1135 * ldap_msgdelete - delete a message. It returns:
1136 * 0 if the entire message was deleted
1137 * -1 if the message was not found, or only part of it was found
1140 ldap_msgdelete( LDAP *ld, int msgid )
1142 LDAPMessage *lm, *prev;
1145 assert( ld != NULL );
1147 Debug( LDAP_DEBUG_TRACE, "ldap_msgdelete\n", 0, 0, 0 );
1150 #ifdef LDAP_R_COMPILE
1151 ldap_pvt_thread_mutex_lock( &ld->ld_res_mutex );
1153 for ( lm = ld->ld_responses; lm != NULL; lm = lm->lm_next ) {
1154 if ( lm->lm_msgid == msgid )
1163 ld->ld_responses = lm->lm_next;
1165 prev->lm_next = lm->lm_next;
1167 #ifdef LDAP_R_COMPILE
1168 ldap_pvt_thread_mutex_unlock( &ld->ld_res_mutex );
1170 if ( lm && ldap_msgfree( lm ) == LDAP_RES_SEARCH_ENTRY )
1180 * return 1 if message msgid is waiting to be abandoned, 0 otherwise
1182 * expects ld_res_mutex to be locked
1185 ldap_abandoned( LDAP *ld, ber_int_t msgid )
1189 #ifdef LDAP_R_COMPILE
1190 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
1193 if ( ld->ld_abandoned == NULL )
1196 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1197 if ( ld->ld_abandoned[i] == msgid )
1205 * ldap_mark_abandoned
1207 * expects ld_res_mutex to be locked
1210 ldap_mark_abandoned( LDAP *ld, ber_int_t msgid )
1214 #ifdef LDAP_R_COMPILE
1215 LDAP_PVT_THREAD_ASSERT_MUTEX_OWNER( &ld->ld_res_mutex );
1218 if ( ld->ld_abandoned == NULL )
1221 for ( i = 0; ld->ld_abandoned[i] != -1; i++ )
1222 if ( ld->ld_abandoned[i] == msgid )
1225 if ( ld->ld_abandoned[i] == -1 )
1228 for ( ; ld->ld_abandoned[i] != -1; i++ ) {
1229 ld->ld_abandoned[i] = ld->ld_abandoned[i + 1];