2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
4 * Copyright 1999-2006 The OpenLDAP Foundation.
5 * Portions Copyright 2001-2003 Pierangelo Masarati.
6 * Portions Copyright 1999-2003 Howard Chu.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted only as authorized by the OpenLDAP
13 * A copy of this license is available in the file LICENSE in the
14 * top-level directory of the distribution or, alternatively, at
15 * <http://www.OpenLDAP.org/license.html>.
18 * This work was initially developed by the Howard Chu for inclusion
19 * in OpenLDAP Software and subsequently enhanced by Pierangelo
28 #include <ac/socket.h>
29 #include <ac/string.h>
34 #include "../back-ldap/back-ldap.h"
35 #include "back-meta.h"
38 * meta_back_conndn_cmp
40 * compares two struct metaconn based on the value of the conn pointer
41 * and of the local DN; used by avl stuff
48 metaconn_t *mc1 = ( metaconn_t * )c1;
49 metaconn_t *mc2 = ( metaconn_t * )c2;
52 /* If local DNs don't match, it is definitely not a match */
53 /* For shared sessions, conn is NULL. Only explicitly
54 * bound sessions will have non-NULL conn.
56 rc = SLAP_PTRCMP( mc1->mc_conn, mc2->mc_conn );
58 rc = ber_bvcmp( &mc1->mc_local_ndn, &mc2->mc_local_ndn );
65 * meta_back_conndnmc_cmp
67 * compares two struct metaconn based on the value of the conn pointer,
68 * the local DN and the struct pointer; used by avl stuff
71 meta_back_conndnmc_cmp(
75 metaconn_t *mc1 = ( metaconn_t * )c1;
76 metaconn_t *mc2 = ( metaconn_t * )c2;
79 /* If local DNs don't match, it is definitely not a match */
80 /* For shared sessions, conn is NULL. Only explicitly
81 * bound sessions will have non-NULL conn.
83 rc = SLAP_PTRCMP( mc1->mc_conn, mc2->mc_conn );
85 rc = ber_bvcmp( &mc1->mc_local_ndn, &mc2->mc_local_ndn );
87 rc = SLAP_PTRCMP( mc1, mc2 );
97 * compares two struct metaconn based on the value of the conn pointer;
105 metaconn_t *mc1 = ( metaconn_t * )c1;
106 metaconn_t *mc2 = ( metaconn_t * )c2;
108 /* For shared sessions, conn is NULL. Only explicitly
109 * bound sessions will have non-NULL conn.
111 return SLAP_PTRCMP( mc1->mc_conn, mc2->mc_conn );
115 * meta_back_conndn_dup
117 * returns -1 in case a duplicate struct metaconn has been inserted;
121 meta_back_conndn_dup(
125 metaconn_t *mc1 = ( metaconn_t * )c1;
126 metaconn_t *mc2 = ( metaconn_t * )c2;
128 /* Cannot have more than one shared session with same DN */
129 if ( mc1->mc_conn == mc2->mc_conn &&
130 dn_match( &mc1->mc_local_ndn, &mc2->mc_local_ndn ) )
139 * Debug stuff (got it from libavl)
141 #if META_BACK_PRINT_CONNTREE > 0
143 ravl_print( Avlnode *root, int depth )
152 ravl_print( root->avl_right, depth + 1 );
154 for ( i = 0; i < depth; i++ ) {
155 fprintf( stderr, "-" );
158 mc = (metaconn_t *)root->avl_data;
159 fprintf( stderr, "mc=%p local=\"%s\" conn=%p %s refcnt=%d%s\n",
161 mc->mc_local_ndn.bv_val ? mc->mc_local_ndn.bv_val : "",
163 avl_bf2str( root->avl_bf ), mc->mc_refcnt,
164 LDAP_BACK_CONN_TAINTED( mc ) ? " tainted" : "" );
166 ravl_print( root->avl_left, depth + 1 );
170 meta_back_print_conntree( Avlnode *root, char *msg )
172 fprintf( stderr, "========> %s\n", msg );
175 fprintf( stderr, "\t(empty)\n" );
178 ravl_print( root, 0 );
181 fprintf( stderr, "<======== %s\n", msg );
183 #endif /* META_BACK_PRINT_CONNTREE */
191 * Allocates a connection structure, making room for all the referenced targets
197 metainfo_t *mi = ( metainfo_t * )op->o_bd->be_private;
199 int ntargets = mi->mi_ntargets;
201 assert( ntargets > 0 );
203 /* malloc all in one */
204 mc = ( metaconn_t * )ch_calloc( 1, sizeof( metaconn_t )
205 + sizeof( metasingleconn_t ) * ntargets );
212 mc->mc_authz_target = META_BOUND_NONE;
219 * meta_back_init_one_conn
221 * Initializes one connection
224 meta_back_init_one_conn(
230 ldap_back_send_t sendok )
232 metainfo_t *mi = ( metainfo_t * )op->o_bd->be_private;
233 metatarget_t *mt = mi->mi_targets[ candidate ];
234 metasingleconn_t *msc = &mc->mc_conns[ candidate ];
237 int isauthz = ( candidate == mc->mc_authz_target );
240 #endif /* HAVE_TLS */
242 /* if the server is quarantined, and
243 * - the current interval did not expire yet, or
244 * - no more retries should occur,
245 * don't return the connection */
246 if ( mt->mt_isquarantined ) {
247 slap_retry_info_t *ri = &mt->mt_quarantine;
250 if ( mt->mt_isquarantined == LDAP_BACK_FQ_YES ) {
251 dont_retry = ( ri->ri_num[ ri->ri_idx ] == SLAP_RETRYNUM_TAIL
252 || slap_get_time() < ri->ri_last + ri->ri_interval[ ri->ri_idx ] );
254 if ( LogTest( LDAP_DEBUG_ANY ) ) {
255 char buf[ SLAP_TEXT_BUFLEN ];
257 snprintf( buf, sizeof( buf ),
258 "meta_back_init_one_conn[%d]: quarantine "
259 "retry block #%d try #%d",
260 candidate, ri->ri_idx, ri->ri_count );
261 Debug( LDAP_DEBUG_ANY, "%s %s.\n",
262 op->o_log_prefix, buf, 0 );
265 mt->mt_isquarantined = LDAP_BACK_FQ_RETRYING;
270 rs->sr_err = LDAP_UNAVAILABLE;
271 if ( op->o_conn && ( sendok & LDAP_BACK_SENDERR ) ) {
272 send_ldap_result( op, rs );
281 if ( msc->msc_ld != NULL ) {
282 return rs->sr_err = LDAP_SUCCESS;
285 msc->msc_mscflags = 0;
288 * Attempts to initialize the connection to the target ds
290 ldap_pvt_thread_mutex_lock( &mt->mt_uri_mutex );
291 rs->sr_err = ldap_initialize( &msc->msc_ld, mt->mt_uri );
293 is_ldaps = ldap_is_ldaps_url( mt->mt_uri );
294 #endif /* HAVE_TLS */
295 ldap_pvt_thread_mutex_unlock( &mt->mt_uri_mutex );
296 if ( rs->sr_err != LDAP_SUCCESS ) {
301 * Set LDAP version. This will always succeed: If the client
302 * bound with a particular version, then so can we.
304 if ( mt->mt_version != 0 ) {
305 version = mt->mt_version;
307 } else if ( op->o_conn->c_protocol != 0 ) {
308 version = op->o_conn->c_protocol;
311 version = LDAP_VERSION3;
313 ldap_set_option( msc->msc_ld, LDAP_OPT_PROTOCOL_VERSION, &version );
314 ldap_set_urllist_proc( msc->msc_ld, mt->mt_urllist_f, mt->mt_urllist_p );
316 /* automatically chase referrals ("chase-referrals [{yes|no}]" statement) */
317 ldap_set_option( msc->msc_ld, LDAP_OPT_REFERRALS,
318 LDAP_BACK_CHASE_REFERRALS( mi ) ? LDAP_OPT_ON : LDAP_OPT_OFF );
321 /* start TLS ("tls [try-]{start|propagate}" statement) */
322 if ( ( LDAP_BACK_USE_TLS( mi ) || ( op->o_conn->c_is_tls && LDAP_BACK_PROPAGATE_TLS( mi ) ) )
325 #ifdef SLAP_STARTTLS_ASYNCHRONOUS
327 * use asynchronous StartTLS; in case, chase referral
328 * FIXME: OpenLDAP does not return referral on StartTLS yet
332 rs->sr_err = ldap_start_tls( msc->msc_ld, NULL, NULL, &msgid );
333 if ( rs->sr_err == LDAP_SUCCESS ) {
334 LDAPMessage *res = NULL;
335 int rc, nretries = mt->mt_nretries;
338 LDAP_BACK_TV_SET( &tv );
341 rc = ldap_result( msc->msc_ld, msgid, LDAP_MSG_ALL, &tv, &res );
344 rs->sr_err = LDAP_OTHER;
348 if ( nretries != 0 ) {
349 if ( nretries > 0 ) {
352 LDAP_BACK_TV_SET( &tv );
355 rs->sr_err = LDAP_OTHER;
359 /* only touch when activity actually took place... */
360 if ( mi->mi_idle_timeout != 0 && msc->msc_time < op->o_time ) {
361 msc->msc_time = op->o_time;
366 if ( rc == LDAP_RES_EXTENDED ) {
367 struct berval *data = NULL;
369 /* NOTE: right now, data is unused, so don't get it */
370 rs->sr_err = ldap_parse_extended_result( msc->msc_ld, res,
371 NULL, NULL /* &data */ , 0 );
372 if ( rs->sr_err == LDAP_SUCCESS ) {
375 /* FIXME: matched? referrals? response controls? */
376 rs->sr_err = ldap_parse_result( msc->msc_ld, res,
377 &err, NULL, NULL, NULL, NULL, 1 );
380 if ( rs->sr_err == LDAP_SUCCESS ) {
384 /* FIXME: in case a referral
385 * is returned, should we try
386 * using it instead of the
388 if ( rs->sr_err == LDAP_SUCCESS ) {
389 ldap_install_tls( msc->msc_ld );
391 } else if ( rs->sr_err == LDAP_REFERRAL ) {
392 /* FIXME: LDAP_OPERATIONS_ERROR? */
393 rs->sr_err = LDAP_OTHER;
394 rs->sr_text = "unwilling to chase referral returned by Start TLS exop";
398 if ( data->bv_val ) {
399 ber_memfree( data->bv_val );
406 rs->sr_err = LDAP_OTHER;
413 #else /* ! SLAP_STARTTLS_ASYNCHRONOUS */
415 * use synchronous StartTLS
417 rs->sr_err = ldap_start_tls_s( msc->msc_ld, NULL, NULL );
418 #endif /* ! SLAP_STARTTLS_ASYNCHRONOUS */
420 /* if StartTLS is requested, only attempt it if the URL
421 * is not "ldaps://"; this may occur not only in case
422 * of misconfiguration, but also when used in the chain
423 * overlay, where the "uri" can be parsed out of a referral */
424 if ( rs->sr_err == LDAP_SERVER_DOWN
425 || ( rs->sr_err != LDAP_SUCCESS && LDAP_BACK_TLS_CRITICAL( mi ) ) )
429 Debug( LDAP_DEBUG_ANY, "### %s meta_back_init_one_conn(TLS) ldap_unbind_ext[%d] ld=%p\n",
430 op->o_log_prefix, candidate, (void *)msc->msc_ld );
431 #endif /* DEBUG_205 */
433 ldap_unbind_ext( msc->msc_ld, NULL, NULL );
438 #endif /* HAVE_TLS */
441 * Set the network timeout if set
443 if ( mt->mt_network_timeout != 0 ) {
444 struct timeval network_timeout;
446 network_timeout.tv_usec = 0;
447 network_timeout.tv_sec = mt->mt_network_timeout;
449 ldap_set_option( msc->msc_ld, LDAP_OPT_NETWORK_TIMEOUT,
450 (void *)&network_timeout );
454 * If the connection DN is not null, an attempt to rewrite it is made
458 if ( !BER_BVISNULL( &mt->mt_idassert_authcDN ) ) {
459 ber_bvreplace( &msc->msc_bound_ndn, &mt->mt_idassert_authcDN );
460 if ( !BER_BVISNULL( &mt->mt_idassert_passwd ) ) {
461 if ( !BER_BVISNULL( &msc->msc_cred ) ) {
462 memset( msc->msc_cred.bv_val, 0,
463 msc->msc_cred.bv_len );
465 ber_bvreplace( &msc->msc_cred, &mt->mt_idassert_passwd );
469 ber_bvreplace( &msc->msc_bound_ndn, &slap_empty_bv );
473 if ( !BER_BVISNULL( &msc->msc_cred ) ) {
474 memset( msc->msc_cred.bv_val, 0, msc->msc_cred.bv_len );
475 ber_memfree_x( msc->msc_cred.bv_val, NULL );
476 BER_BVZERO( &msc->msc_cred );
478 if ( !BER_BVISNULL( &msc->msc_bound_ndn ) ) {
479 ber_memfree_x( msc->msc_bound_ndn.bv_val, NULL );
480 BER_BVZERO( &msc->msc_bound_ndn );
482 if ( !BER_BVISEMPTY( &op->o_ndn )
483 && SLAP_IS_AUTHZ_BACKEND( op )
487 dc.conn = op->o_conn;
492 * Rewrite the bind dn if needed
494 if ( ldap_back_dn_massage( &dc, &op->o_conn->c_dn,
495 &msc->msc_bound_ndn ) )
499 Debug( LDAP_DEBUG_ANY, "### %s meta_back_init_one_conn(rewrite) ldap_unbind_ext[%d] ld=%p\n",
500 op->o_log_prefix, candidate, (void *)msc->msc_ld );
501 #endif /* DEBUG_205 */
503 ldap_unbind_ext( msc->msc_ld, NULL, NULL );
508 /* copy the DN if needed */
509 if ( msc->msc_bound_ndn.bv_val == op->o_conn->c_dn.bv_val ) {
510 ber_dupbv( &msc->msc_bound_ndn, &op->o_conn->c_dn );
514 ber_dupbv( &msc->msc_bound_ndn, (struct berval *)&slap_empty_bv );
518 assert( !BER_BVISNULL( &msc->msc_bound_ndn ) );
521 if ( rs->sr_err == LDAP_SUCCESS ) {
523 * Sets a cookie for the rewrite session
525 ( void )rewrite_session_init( mt->mt_rwmap.rwm_rw, op->o_conn );
528 rs->sr_err = slap_map_api2result( rs );
529 if ( sendok & LDAP_BACK_SENDERR ) {
530 send_ldap_result( op, rs );
541 * Retries one connection
549 ldap_back_send_t sendok )
551 metainfo_t *mi = ( metainfo_t * )op->o_bd->be_private;
552 metatarget_t *mt = mi->mi_targets[ candidate ];
553 metaconn_t *mc = *mcp;
554 metasingleconn_t *msc = &mc->mc_conns[ candidate ];
555 int rc = LDAP_UNAVAILABLE,
558 ldap_pvt_thread_mutex_lock( &mi->mi_conninfo.lai_mutex );
559 binding = LDAP_BACK_CONN_BINDING( msc );
561 assert( mc->mc_refcnt > 0 );
562 if ( mc->mc_refcnt == 1 ) {
563 if ( LogTest( LDAP_DEBUG_ANY ) ) {
564 char buf[ SLAP_TEXT_BUFLEN ];
566 ldap_pvt_thread_mutex_lock( &mt->mt_uri_mutex );
567 snprintf( buf, sizeof( buf ),
568 "retrying URI=\"%s\" DN=\"%s\"",
570 BER_BVISNULL( &msc->msc_bound_ndn ) ?
571 "" : msc->msc_bound_ndn.bv_val );
572 ldap_pvt_thread_mutex_unlock( &mt->mt_uri_mutex );
574 Debug( LDAP_DEBUG_ANY,
575 "%s meta_back_retry[%d]: %s.\n",
576 op->o_log_prefix, candidate, buf );
579 meta_clear_one_candidate( op, mc, candidate );
580 LDAP_BACK_CONN_ISBOUND_CLEAR( msc );
582 ( void )rewrite_session_delete( mt->mt_rwmap.rwm_rw, op->o_conn );
584 /* mc here must be the regular mc, reset and ready for init */
585 rc = meta_back_init_one_conn( op, rs, mc, candidate,
586 LDAP_BACK_CONN_ISPRIV( mc ), sendok );
588 /* restore the "binding" flag, in case */
590 LDAP_BACK_CONN_BINDING_SET( msc );
593 if ( rc == LDAP_SUCCESS ) {
594 rc = meta_back_single_dobind( op, rs, mcp, candidate,
595 sendok, mt->mt_nretries, 0 );
597 Debug( LDAP_DEBUG_ANY,
598 "%s meta_back_retry[%d]: "
599 "meta_back_single_dobind=%d\n",
600 op->o_log_prefix, candidate, rc );
601 if ( rc == LDAP_SUCCESS ) {
602 if ( !BER_BVISNULL( &msc->msc_bound_ndn ) &&
603 !BER_BVISEMPTY( &msc->msc_bound_ndn ) )
605 LDAP_BACK_CONN_ISBOUND_SET( msc );
608 LDAP_BACK_CONN_ISANON_SET( msc );
611 /* when bound, dispose of the "binding" flag */
613 LDAP_BACK_CONN_BINDING_CLEAR( msc );
619 if ( rc != LDAP_SUCCESS ) {
620 SlapReply *candidates = meta_back_candidates_get( op );
622 candidates[ candidate ].sr_err = rc;
624 if ( *mcp != NULL ) {
626 LDAP_BACK_CONN_BINDING_CLEAR( msc );
628 LDAP_BACK_CONN_TAINTED_SET( mc );
629 /* only release if mandatory; otherwise
630 * let the caller do what's best before
632 if ( META_BACK_ONERR_STOP( mi ) ) {
633 meta_back_release_conn_lock( op, mc, 0 );
641 send_ldap_result( op, rs );
645 if ( META_BACK_TGT_QUARANTINE( mt ) ) {
646 meta_back_quarantine( op, rs, candidate );
649 ldap_pvt_thread_mutex_unlock( &mi->mi_conninfo.lai_mutex );
651 return rc == LDAP_SUCCESS ? 1 : 0;
655 * callback for unique candidate selection
658 meta_back_conn_cb( Operation *op, SlapReply *rs )
660 assert( op->o_tag == LDAP_REQ_SEARCH );
662 switch ( rs->sr_type ) {
664 ((long *)op->o_callback->sc_private)[0] = (long)op->o_private;
680 meta_back_get_candidate(
685 metainfo_t *mi = ( metainfo_t * )op->o_bd->be_private;
689 * tries to get a unique candidate
690 * (takes care of default target)
692 candidate = meta_back_select_unique_candidate( mi, ndn );
695 * if any is found, inits the connection
697 if ( candidate == META_TARGET_NONE ) {
698 rs->sr_err = LDAP_NO_SUCH_OBJECT;
699 rs->sr_text = "no suitable candidate target found";
701 } else if ( candidate == META_TARGET_MULTIPLE ) {
704 SlapReply rs2 = { 0 };
705 slap_callback cb2 = { 0 };
708 /* try to get a unique match for the request ndn
709 * among the multiple candidates available */
710 op2.o_tag = LDAP_REQ_SEARCH;
712 op2.o_req_ndn = *ndn;
713 op2.ors_scope = LDAP_SCOPE_BASE;
714 op2.ors_deref = LDAP_DEREF_NEVER;
715 op2.ors_attrs = slap_anlist_no_attrs;
716 op2.ors_attrsonly = 0;
717 op2.ors_limit = NULL;
719 op2.ors_tlimit = SLAP_NO_LIMIT;
721 f.f_choice = LDAP_FILTER_PRESENT;
722 f.f_desc = slap_schema.si_ad_objectClass;
724 BER_BVSTR( &op2.ors_filterstr, "(objectClass=*)" );
726 op2.o_callback = &cb2;
727 cb2.sc_response = meta_back_conn_cb;
728 cb2.sc_private = (void *)&candidate;
730 rc = op->o_bd->be_search( &op2, &rs2 );
732 switch ( rs2.sr_err ) {
735 rs->sr_err = rs2.sr_err;
738 case LDAP_SIZELIMIT_EXCEEDED:
739 /* if multiple candidates can serve the operation,
740 * and a default target is defined, and it is
741 * a candidate, try using it (FIXME: YMMV) */
742 if ( mi->mi_defaulttarget != META_DEFAULT_TARGET_NONE
743 && meta_back_is_candidate( mi->mi_targets[ mi->mi_defaulttarget ],
744 ndn, op->o_tag == LDAP_REQ_SEARCH ? op->ors_scope : LDAP_SCOPE_BASE ) )
746 candidate = mi->mi_defaulttarget;
747 rs->sr_err = LDAP_SUCCESS;
751 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
752 rs->sr_text = "cannot select unique candidate target";
758 rs->sr_err = LDAP_SUCCESS;
764 static void *meta_back_candidates_dummy;
767 meta_back_candidates_keyfree(
771 metacandidates_t *mc = (metacandidates_t *)data;
773 ber_memfree_x( mc->mc_candidates, NULL );
774 ber_memfree_x( data, NULL );
778 meta_back_candidates_get( Operation *op )
780 metainfo_t *mi = ( metainfo_t * )op->o_bd->be_private;
781 metacandidates_t *mc;
783 if ( op->o_threadctx ) {
786 ldap_pvt_thread_pool_getkey( op->o_threadctx,
787 &meta_back_candidates_dummy, &data, NULL );
788 mc = (metacandidates_t *)data;
791 mc = mi->mi_candidates;
795 mc = ch_calloc( sizeof( metacandidates_t ), 1 );
796 mc->mc_ntargets = mi->mi_ntargets;
797 mc->mc_candidates = ch_calloc( sizeof( SlapReply ), mc->mc_ntargets );
798 if ( op->o_threadctx ) {
802 ldap_pvt_thread_pool_setkey( op->o_threadctx,
803 &meta_back_candidates_dummy, data,
804 meta_back_candidates_keyfree );
807 mi->mi_candidates = mc;
810 } else if ( mc->mc_ntargets < mi->mi_ntargets ) {
811 /* NOTE: in the future, may want to allow back-config
812 * to add/remove targets from back-meta... */
813 mc->mc_candidates = ch_realloc( mc->mc_candidates,
814 sizeof( SlapReply ) * mi->mi_ntargets );
815 memset( &mc->mc_candidates[ mc->mc_ntargets ], 0,
816 sizeof( SlapReply ) * ( mi->mi_ntargets - mc->mc_ntargets ) );
817 mc->mc_ntargets = mi->mi_ntargets;
820 return mc->mc_candidates;
826 * Prepares the connection structure
830 * - determine what DN is being requested:
832 * op requires candidate checks
834 * add unique parent of o_req_ndn
835 * bind unique^*[/all] o_req_ndn [no check]
836 * compare unique^+ o_req_ndn
837 * delete unique o_req_ndn
838 * modify unique o_req_ndn
839 * search any o_req_ndn
840 * modrdn unique[, unique] o_req_ndn[, orr_nnewSup]
842 * - for ops that require the candidate to be unique, in case of multiple
843 * occurrences an internal search with sizeLimit=1 is performed
844 * if a unique candidate can actually be determined. If none is found,
845 * the operation aborts; if multiple are found, the default target
846 * is used if defined and candidate; otherwise the operation aborts.
848 * *^note: actually, the bind operation is handled much like a search;
849 * i.e. the bind is broadcast to all candidate targets.
851 * +^note: actually, the compare operation is handled much like a search;
852 * i.e. the compare is broadcast to all candidate targets, while checking
853 * that exactly none (noSuchObject) or one (TRUE/FALSE/UNDEFINED) is
861 ldap_back_send_t sendok )
863 metainfo_t *mi = ( metainfo_t * )op->o_bd->be_private;
864 metaconn_t *mc = NULL,
866 int cached = META_TARGET_NONE,
867 i = META_TARGET_NONE,
873 meta_op_type op_type = META_OP_REQUIRE_SINGLE;
877 META_DNTYPE_NEWPARENT
878 } dn_type = META_DNTYPE_ENTRY;
879 struct berval ndn = op->o_req_ndn,
882 SlapReply *candidates = meta_back_candidates_get( op );
884 /* Internal searches are privileged and shared. So is root. */
885 /* FIXME: there seem to be concurrency issues */
886 if ( op->o_do_not_cache || be_isroot( op ) ) {
887 mc_curr.mc_local_ndn = op->o_bd->be_rootndn;
888 LDAP_BACK_CONN_ISPRIV_SET( &mc_curr );
889 mc_curr.mc_conn = LDAP_BACK_PCONN_SET( op );
892 mc_curr.mc_local_ndn = op->o_ndn;
894 /* Explicit binds must not be shared */
895 if ( op->o_tag == LDAP_REQ_BIND || SLAP_IS_AUTHZ_BACKEND( op ) ) {
896 mc_curr.mc_conn = op->o_conn;
899 mc_curr.mc_conn = LDAP_BACK_PCONN_SET( op );
903 /* Explicit Bind requests always get their own conn */
904 if ( !( sendok & LDAP_BACK_BINDING ) ) {
905 /* Searches for a metaconn in the avl tree */
907 ldap_pvt_thread_mutex_lock( &mi->mi_conninfo.lai_mutex );
908 mc = (metaconn_t *)avl_find( mi->mi_conninfo.lai_tree,
909 (caddr_t)&mc_curr, meta_back_conndn_cmp );
911 if ( ( mi->mi_conn_ttl != 0 && op->o_time > mc->mc_create_time + mi->mi_conn_ttl )
912 || ( mi->mi_idle_timeout != 0 && op->o_time > mc->mc_time + mi->mi_idle_timeout ) )
914 #if META_BACK_PRINT_CONNTREE > 0
915 meta_back_print_conntree( mi->mi_conninfo.lai_tree, ">>> meta_back_getconn" );
916 #endif /* META_BACK_PRINT_CONNTREE */
917 /* don't let anyone else use this expired connection */
918 (void)avl_delete( &mi->mi_conninfo.lai_tree,
919 (caddr_t)mc, meta_back_conndnmc_cmp );
920 #if META_BACK_PRINT_CONNTREE > 0
921 meta_back_print_conntree( mi->mi_conninfo.lai_tree, "<<< meta_back_getconn" );
922 #endif /* META_BACK_PRINT_CONNTREE */
923 LDAP_BACK_CONN_TAINTED_SET( mc );
925 Debug( LDAP_DEBUG_TRACE, "%s meta_back_getconn: mc=%p conn=%ld expired.\n",
926 op->o_log_prefix, (void *)mc, LDAP_BACK_PCONN_ID( mc ) );
929 /* Don't reuse connections while they're still binding
930 * NOTE: only makes sense for binds */
931 if ( LDAP_BACK_CONN_BINDING( mc ) ) {
932 ldap_pvt_thread_mutex_unlock( &mi->mi_conninfo.lai_mutex );
933 ldap_pvt_thread_yield();
939 ldap_pvt_thread_mutex_unlock( &mi->mi_conninfo.lai_mutex );
942 switch ( op->o_tag ) {
944 /* if we go to selection, the entry must not exist,
945 * and we must be able to resolve the parent */
946 dn_type = META_DNTYPE_PARENT;
947 dnParent( &ndn, &pndn );
950 case LDAP_REQ_MODRDN:
951 /* if nnewSuperior is not NULL, it must resolve
952 * to the same candidate as the req_ndn */
953 if ( op->orr_nnewSup ) {
954 dn_type = META_DNTYPE_NEWPARENT;
959 /* if bound as rootdn, the backend must bind to all targets
960 * with the administrative identity */
961 if ( op->orb_method == LDAP_AUTH_SIMPLE && be_isroot_pw( op ) ) {
962 op_type = META_OP_REQUIRE_ALL;
966 case LDAP_REQ_COMPARE:
967 case LDAP_REQ_DELETE:
968 case LDAP_REQ_MODIFY:
969 /* just a unique candidate */
972 case LDAP_REQ_SEARCH:
973 /* allow multiple candidates for the searchBase */
974 op_type = META_OP_ALLOW_MULTIPLE;
978 /* right now, just break (exop?) */
983 * require all connections ...
985 if ( op_type == META_OP_REQUIRE_ALL ) {
987 /* Looks like we didn't get a bind. Open a new session... */
989 assert( new_conn == 0 );
990 mc = metaconn_alloc( op );
991 mc->mc_conn = mc_curr.mc_conn;
992 ber_dupbv( &mc->mc_local_ndn, &mc_curr.mc_local_ndn );
994 if ( sendok & LDAP_BACK_BINDING ) {
995 LDAP_BACK_CONN_BINDING_SET( mc );
997 if ( LDAP_BACK_CONN_ISPRIV( &mc_curr ) ) {
998 LDAP_BACK_CONN_ISPRIV_SET( mc );
1002 /* TODO: if any of the connections is binding,
1003 * release mc and create a new one */
1006 for ( i = 0; i < mi->mi_ntargets; i++ ) {
1008 * The target is activated; if needed, it is
1011 candidates[ i ].sr_err = meta_back_init_one_conn( op,
1012 rs, mc, i, LDAP_BACK_CONN_ISPRIV( &mc_curr ),
1014 if ( candidates[ i ].sr_err == LDAP_SUCCESS ) {
1015 META_CANDIDATE_SET( &candidates[ i ] );
1021 * FIXME: in case one target cannot
1022 * be init'd, should the other ones
1025 META_CANDIDATE_RESET( &candidates[ i ] );
1026 err = candidates[ i ].sr_err;
1031 if ( ncandidates == 0 ) {
1034 meta_back_conn_free( mc );
1037 meta_back_release_conn( op, mc );
1040 rs->sr_err = LDAP_NO_SUCH_OBJECT;
1041 rs->sr_text = "Unable to select valid candidates";
1043 if ( sendok & LDAP_BACK_SENDERR ) {
1044 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
1045 rs->sr_matched = op->o_bd->be_suffix[ 0 ].bv_val;
1047 send_ldap_result( op, rs );
1049 rs->sr_matched = NULL;
1059 * looks in cache, if any
1061 if ( mi->mi_cache.ttl != META_DNCACHE_DISABLED ) {
1062 cached = i = meta_dncache_get_target( &mi->mi_cache, &op->o_req_ndn );
1065 if ( op_type == META_OP_REQUIRE_SINGLE ) {
1066 metatarget_t *mt = NULL;
1067 metasingleconn_t *msc = NULL;
1071 for ( j = 0; j < mi->mi_ntargets; j++ ) {
1072 META_CANDIDATE_RESET( &candidates[ j ] );
1076 * tries to get a unique candidate
1077 * (takes care of default target)
1079 if ( i == META_TARGET_NONE ) {
1080 i = meta_back_get_candidate( op, rs, &ndn );
1082 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT && dn_type == META_DNTYPE_PARENT ) {
1083 i = meta_back_get_candidate( op, rs, &pndn );
1086 if ( i < 0 || rs->sr_err != LDAP_SUCCESS ) {
1088 meta_back_release_conn( op, mc );
1091 if ( sendok & LDAP_BACK_SENDERR ) {
1092 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
1093 rs->sr_matched = op->o_bd->be_suffix[ 0 ].bv_val;
1095 send_ldap_result( op, rs );
1097 rs->sr_matched = NULL;
1104 if ( dn_type == META_DNTYPE_NEWPARENT && meta_back_get_candidate( op, rs, op->orr_nnewSup ) != i )
1107 meta_back_release_conn( op, mc );
1110 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
1111 rs->sr_text = "cross-target rename not supported";
1112 if ( sendok & LDAP_BACK_SENDERR ) {
1113 send_ldap_result( op, rs );
1120 Debug( LDAP_DEBUG_TRACE,
1121 "==>meta_back_getconn: got target=%d for ndn=\"%s\" from cache\n",
1122 i, op->o_req_ndn.bv_val, 0 );
1125 /* Retries searching for a metaconn in the avl tree
1126 * the reason is that the connection might have been
1127 * created by meta_back_get_candidate() */
1128 if ( !( sendok & LDAP_BACK_BINDING ) ) {
1130 ldap_pvt_thread_mutex_lock( &mi->mi_conninfo.lai_mutex );
1131 mc = (metaconn_t *)avl_find( mi->mi_conninfo.lai_tree,
1132 (caddr_t)&mc_curr, meta_back_conndn_cmp );
1134 /* Don't reuse connections while they're still binding */
1135 if ( LDAP_BACK_CONN_BINDING( &mc->mc_conns[ i ] ) ) {
1136 ldap_pvt_thread_mutex_unlock( &mi->mi_conninfo.lai_mutex );
1137 ldap_pvt_thread_yield();
1142 ldap_pvt_thread_mutex_unlock( &mi->mi_conninfo.lai_mutex );
1145 /* Looks like we didn't get a bind. Open a new session... */
1147 assert( new_conn == 0 );
1148 mc = metaconn_alloc( op );
1149 mc->mc_conn = mc_curr.mc_conn;
1150 ber_dupbv( &mc->mc_local_ndn, &mc_curr.mc_local_ndn );
1152 if ( sendok & LDAP_BACK_BINDING ) {
1153 LDAP_BACK_CONN_BINDING_SET( mc );
1155 if ( LDAP_BACK_CONN_ISPRIV( &mc_curr ) ) {
1156 LDAP_BACK_CONN_ISPRIV_SET( mc );
1162 * Clear all other candidates
1164 ( void )meta_clear_unused_candidates( op, i );
1166 mt = mi->mi_targets[ i ];
1167 msc = &mc->mc_conns[ i ];
1170 * The target is activated; if needed, it is
1171 * also init'd. In case of error, meta_back_init_one_conn
1172 * sends the appropriate result.
1174 err = meta_back_init_one_conn( op, rs, mc, i,
1175 LDAP_BACK_CONN_ISPRIV( &mc_curr ), sendok );
1176 if ( err != LDAP_SUCCESS ) {
1178 * FIXME: in case one target cannot
1179 * be init'd, should the other ones
1182 META_CANDIDATE_RESET( &candidates[ i ] );
1185 meta_back_conn_free( mc );
1188 meta_back_release_conn( op, mc );
1193 candidates[ i ].sr_err = LDAP_SUCCESS;
1194 META_CANDIDATE_SET( &candidates[ i ] );
1202 * if no unique candidate ...
1206 /* Looks like we didn't get a bind. Open a new session... */
1208 assert( new_conn == 0 );
1209 mc = metaconn_alloc( op );
1210 mc->mc_conn = mc_curr.mc_conn;
1211 ber_dupbv( &mc->mc_local_ndn, &mc_curr.mc_local_ndn );
1213 if ( LDAP_BACK_CONN_ISPRIV( &mc_curr ) ) {
1214 LDAP_BACK_CONN_ISPRIV_SET( mc );
1218 for ( i = 0; i < mi->mi_ntargets; i++ ) {
1219 metatarget_t *mt = mi->mi_targets[ i ];
1221 META_CANDIDATE_RESET( &candidates[ i ] );
1224 || meta_back_is_candidate( mt, &op->o_req_ndn,
1225 LDAP_SCOPE_SUBTREE ) )
1229 * The target is activated; if needed, it is
1232 int lerr = meta_back_init_one_conn( op, rs, mc, i,
1233 LDAP_BACK_CONN_ISPRIV( &mc_curr ), LDAP_BACK_DONTSEND );
1234 if ( lerr == LDAP_SUCCESS ) {
1235 META_CANDIDATE_SET( &candidates[ i ] );
1236 candidates[ i ].sr_err = LDAP_SUCCESS;
1239 Debug( LDAP_DEBUG_TRACE, "%s: meta_back_getconn[%d]\n",
1240 op->o_log_prefix, i, 0 );
1242 } else if ( lerr == LDAP_UNAVAILABLE && !META_BACK_ONERR_STOP( mi ) ) {
1243 META_CANDIDATE_SET( &candidates[ i ] );
1244 candidates[ i ].sr_err = LDAP_UNAVAILABLE;
1246 Debug( LDAP_DEBUG_TRACE, "%s: meta_back_getconn[%d] %s\n",
1247 op->o_log_prefix, i,
1248 mt->mt_isquarantined != LDAP_BACK_FQ_NO ? "quarantined" : "unavailable" );
1253 * FIXME: in case one target cannot
1254 * be init'd, should the other ones
1258 ( void )meta_clear_one_candidate( op, mc, i );
1260 /* leave the target candidate, but record the error for later use */
1261 candidates[ i ].sr_err = lerr;
1264 if ( lerr == LDAP_UNAVAILABLE && mt->mt_isquarantined != LDAP_BACK_FQ_NO ) {
1265 Debug( LDAP_DEBUG_TRACE, "%s: meta_back_getconn[%d] quarantined: %d\n",
1266 op->o_log_prefix, i, lerr );
1269 Debug( LDAP_DEBUG_ANY, "%s: meta_back_getconn[%d] failed: %d\n",
1270 op->o_log_prefix, i, lerr );
1273 if ( META_BACK_ONERR_STOP( mi ) ) {
1274 if ( sendok & LDAP_BACK_SENDERR ) {
1275 send_ldap_result( op, rs );
1280 meta_back_conn_free( mc );
1283 meta_back_release_conn( op, mc );
1295 ( void )meta_clear_one_candidate( op, mc, i );
1300 if ( ncandidates == 0 ) {
1303 meta_back_conn_free( mc );
1306 meta_back_release_conn( op, mc );
1309 if ( rs->sr_err == LDAP_SUCCESS ) {
1310 rs->sr_err = LDAP_NO_SUCH_OBJECT;
1311 rs->sr_text = "Unable to select valid candidates";
1314 if ( sendok & LDAP_BACK_SENDERR ) {
1315 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
1316 rs->sr_matched = op->o_bd->be_suffix[ 0 ].bv_val;
1318 send_ldap_result( op, rs );
1320 rs->sr_matched = NULL;
1328 /* clear out meta_back_init_one_conn non-fatal errors */
1329 rs->sr_err = LDAP_SUCCESS;
1332 /* touch the timestamp */
1333 if ( mi->mi_idle_timeout != 0 ) {
1334 mc->mc_time = op->o_time;
1338 if ( mi->mi_conn_ttl ) {
1339 mc->mc_create_time = op->o_time;
1343 * Inserts the newly created metaconn in the avl tree
1345 ldap_pvt_thread_mutex_lock( &mi->mi_conninfo.lai_mutex );
1346 #if META_BACK_PRINT_CONNTREE > 0
1347 meta_back_print_conntree( mi->mi_conninfo.lai_tree, ">>> meta_back_getconn" );
1348 #endif /* META_BACK_PRINT_CONNTREE */
1349 err = avl_insert( &mi->mi_conninfo.lai_tree, ( caddr_t )mc,
1350 meta_back_conndn_cmp, meta_back_conndn_dup );
1351 #if META_BACK_PRINT_CONNTREE > 0
1352 meta_back_print_conntree( mi->mi_conninfo.lai_tree, ">>> meta_back_getconn" );
1353 #endif /* META_BACK_PRINT_CONNTREE */
1354 ldap_pvt_thread_mutex_unlock( &mi->mi_conninfo.lai_mutex );
1357 * Err could be -1 in case a duplicate metaconn is inserted
1364 /* duplicate: free and try to get the newly created one */
1365 if ( !( sendok & LDAP_BACK_BINDING ) ) {
1369 LDAP_BACK_CONN_TAINTED_SET( mc );
1373 Debug( LDAP_DEBUG_ANY,
1374 "%s meta_back_getconn: candidates=%d conn=%ld insert failed\n",
1375 op->o_log_prefix, ncandidates,
1376 LDAP_BACK_PCONN_ID( mc ) );
1379 meta_back_conn_free( mc );
1381 rs->sr_err = LDAP_OTHER;
1382 rs->sr_text = "proxy bind collision";
1383 if ( sendok & LDAP_BACK_SENDERR ) {
1384 send_ldap_result( op, rs );
1390 Debug( LDAP_DEBUG_TRACE,
1391 "%s meta_back_getconn: candidates=%d conn=%ld inserted\n",
1392 op->o_log_prefix, ncandidates,
1393 LDAP_BACK_PCONN_ID( mc ) );
1396 Debug( LDAP_DEBUG_TRACE,
1397 "%s meta_back_getconn: candidates=%d conn=%ld fetched\n",
1398 op->o_log_prefix, ncandidates,
1399 LDAP_BACK_PCONN_ID( mc ) );
1406 meta_back_release_conn_lock(
1411 metainfo_t *mi = ( metainfo_t * )op->o_bd->be_private;
1413 assert( mc != NULL );
1416 ldap_pvt_thread_mutex_lock( &mi->mi_conninfo.lai_mutex );
1418 assert( mc->mc_refcnt > 0 );
1420 /* NOTE: the connection is removed if either it is tainted
1421 * or if it is shared and no one else is using it. This needs
1422 * to occur because for intrinsic reasons cached connections
1423 * that are not privileged would live forever and pollute
1424 * the connection space (and eat up resources). Maybe this
1425 * should be configurable... */
1426 if ( LDAP_BACK_CONN_TAINTED( mc ) ||
1427 ( !LDAP_BACK_CONN_ISPRIV( mc ) &&
1428 LDAP_BACK_PCONN_ISPRIV( mc ) &&
1429 mc->mc_refcnt == 0 ) )
1431 Debug( LDAP_DEBUG_TRACE, "%s meta_back_release_conn: mc=%p conn=%ld tainted.\n",
1432 op->o_log_prefix, (void *)mc, LDAP_BACK_PCONN_ID( mc ) );
1433 #if META_BACK_PRINT_CONNTREE > 0
1434 meta_back_print_conntree( mi->mi_conninfo.lai_tree, ">>> meta_back_release_conn" );
1435 #endif /* META_BACK_PRINT_CONNTREE */
1436 (void)avl_delete( &mi->mi_conninfo.lai_tree,
1437 ( caddr_t )mc, meta_back_conndnmc_cmp );
1438 #if META_BACK_PRINT_CONNTREE > 0
1439 meta_back_print_conntree( mi->mi_conninfo.lai_tree, "<<< meta_back_release_conn" );
1440 #endif /* META_BACK_PRINT_CONNTREE */
1441 if ( mc->mc_refcnt == 0 ) {
1442 meta_back_conn_free( mc );
1448 LDAP_BACK_CONN_BINDING_CLEAR( mc );
1452 ldap_pvt_thread_mutex_unlock( &mi->mi_conninfo.lai_mutex );
1457 meta_back_quarantine(
1462 metainfo_t *mi = (metainfo_t *)op->o_bd->be_private;
1463 metatarget_t *mt = mi->mi_targets[ candidate ];
1465 slap_retry_info_t *ri = &mt->mt_quarantine;
1467 ldap_pvt_thread_mutex_lock( &mt->mt_quarantine_mutex );
1469 if ( rs->sr_err == LDAP_UNAVAILABLE ) {
1470 time_t new_last = slap_get_time();
1472 switch ( mt->mt_isquarantined ) {
1473 case LDAP_BACK_FQ_NO:
1474 if ( ri->ri_last == new_last ) {
1478 Debug( LDAP_DEBUG_ANY,
1479 "%s meta_back_quarantine[%d]: enter.\n",
1480 op->o_log_prefix, candidate, 0 );
1486 case LDAP_BACK_FQ_RETRYING:
1487 if ( LogTest( LDAP_DEBUG_ANY ) ) {
1488 char buf[ SLAP_TEXT_BUFLEN ];
1490 snprintf( buf, sizeof( buf ),
1491 "meta_back_quarantine[%d]: block #%d try #%d failed",
1492 candidate, ri->ri_idx, ri->ri_count );
1493 Debug( LDAP_DEBUG_ANY, "%s %s.\n",
1494 op->o_log_prefix, buf, 0 );
1498 if ( ri->ri_num[ ri->ri_idx ] != SLAP_RETRYNUM_FOREVER
1499 && ri->ri_count == ri->ri_num[ ri->ri_idx ] )
1510 mt->mt_isquarantined = LDAP_BACK_FQ_YES;
1511 ri->ri_last = new_last;
1513 } else if ( mt->mt_isquarantined == LDAP_BACK_FQ_RETRYING ) {
1514 Debug( LDAP_DEBUG_ANY,
1515 "%s meta_back_quarantine[%d]: exit.\n",
1516 op->o_log_prefix, candidate, 0 );
1518 if ( mi->mi_quarantine_f ) {
1519 (void)mi->mi_quarantine_f( mi, candidate,
1520 mi->mi_quarantine_p );
1525 mt->mt_isquarantined = LDAP_BACK_FQ_NO;
1529 ldap_pvt_thread_mutex_unlock( &mt->mt_quarantine_mutex );