git.sur5r.net Git - openldap/blob - servers/slapd/back-meta/conn.c

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1999-2005 The OpenLDAP Foundation.
   5  * Portions Copyright 2001-2003 Pierangelo Masarati.
   6  * Portions Copyright 1999-2003 Howard Chu.
   7  * All rights reserved.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted only as authorized by the OpenLDAP
  11  * Public License.
  12  *
  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>.
  16  */
  17 /* ACKNOWLEDGEMENTS:
  18  * This work was initially developed by the Howard Chu for inclusion
  19  * in OpenLDAP Software and subsequently enhanced by Pierangelo
  20  * Masarati.
  21  */
  22
  23 #include "portable.h"
  24
  25 #include <stdio.h>
  26
  27 #include <ac/errno.h>
  28 #include <ac/socket.h>
  29 #include <ac/string.h>
  30
  31
  32 #define AVL_INTERNAL
  33 #include "slap.h"
  34 #include "../back-ldap/back-ldap.h"
  35 #include "back-meta.h"
  36
  37 /*
  38  * Set PRINT_CONNTREE larger than 0 to dump the connection tree (debug only)
  39  */
  40 #define PRINT_CONNTREE 0
  41
  42 /*
  43  * meta_back_conn_cmp
  44  *
  45  * compares two struct metaconn based on the value of the conn pointer;
  46  * used by avl stuff
  47  */
  48 int
  49 meta_back_conn_cmp(
  50         const void *c1,
  51         const void *c2 )
  52 {
  53         metaconn_t      *mc1 = ( metaconn_t * )c1;
  54         metaconn_t      *mc2 = ( metaconn_t * )c2;
  55         int             rc;
  56
  57         /* If local DNs don't match, it is definitely not a match */
  58         rc = ber_bvcmp( &mc1->mc_local_ndn, &mc2->mc_local_ndn );
  59         if ( rc ) {
  60                 return rc;
  61         }
  62
  63         /* For shared sessions, conn is NULL. Only explicitly
  64          * bound sessions will have non-NULL conn.
  65          */
  66         return SLAP_PTRCMP( mc1->mc_conn, mc2->mc_conn );
  67 }
  68
  69 /*
  70  * meta_back_conn_dup
  71  *
  72  * returns -1 in case a duplicate struct metaconn has been inserted;
  73  * used by avl stuff
  74  */
  75 int
  76 meta_back_conn_dup(
  77         void *c1,
  78         void *c2 )
  79 {
  80         metaconn_t      *mc1 = ( metaconn_t * )c1;
  81         metaconn_t      *mc2 = ( metaconn_t * )c2;
  82
  83         /* Cannot have more than one shared session with same DN */
  84         if ( dn_match( &mc1->mc_local_ndn, &mc2->mc_local_ndn ) &&
  85                         mc1->mc_conn == mc2->mc_conn )
  86         {
  87                 return -1;
  88         }
  89
  90         return 0;
  91 }
  92
  93 /*
  94  * Debug stuff (got it from libavl)
  95  */
  96 #if PRINT_CONNTREE > 0
  97 static void
  98 ravl_print( Avlnode *root, int depth )
  99 {
 100         int             i;
 101         metaconn_t      *mc = (metaconn_t *)root->avl_data;
 102
 103         if ( root == 0 ) {
 104                 return;
 105         }
 106
 107         ravl_print( root->avl_right, depth + 1 );
 108
 109         for ( i = 0; i < depth; i++ ) {
 110                 printf( "    " );
 111         }
 112
 113         printf( "c(%d%s%s) %d\n",
 114                 LDAP_BACK_PCONN_ID( mc->mc_conn ),
 115                 BER_BVISNULL( &mc->mc_local_ndn ) ? "" : ": ",
 116                 BER_BVISNULL( &mc->mc_local_ndn ) ? "" : mc->mc_local_ndn.bv_val,
 117                 root->avl_bf );
 118
 119         ravl_print( root->avl_left, depth + 1 );
 120 }
 121
 122 static void
 123 myprint( Avlnode *root )
 124 {
 125         printf( "********\n" );
 126
 127         if ( root == 0 ) {
 128                 printf( "\tNULL\n" );
 129         } else {
 130                 ravl_print( root, 0 );
 131         }
 132
 133         printf( "********\n" );
 134 }
 135 #endif /* PRINT_CONNTREE */
 136 /*
 137  * End of debug stuff
 138  */
 139
 140 /*
 141  * metaconn_alloc
 142  *
 143  * Allocates a connection structure, making room for all the referenced targets
 144  */
 145 static metaconn_t *
 146 metaconn_alloc(
 147         Operation               *op )
 148 {
 149         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 150         metaconn_t      *mc;
 151         int             i, ntargets = mi->mi_ntargets;
 152
 153         assert( ntargets > 0 );
 154
 155         /* malloc all in one */
 156         mc = ( metaconn_t * )ch_malloc( sizeof( metaconn_t )
 157                         + sizeof( metasingleconn_t ) * ntargets );
 158         if ( mc == NULL ) {
 159                 return NULL;
 160         }
 161
 162         for ( i = 0; i < ntargets; i++ ) {
 163                 mc->mc_conns[ i ].msc_ld = NULL;
 164                 BER_BVZERO( &mc->mc_conns[ i ].msc_bound_ndn );
 165                 BER_BVZERO( &mc->mc_conns[ i ].msc_cred );
 166                 LDAP_BACK_CONN_ISBOUND_CLEAR( &mc->mc_conns[ i ] );
 167                 mc->mc_conns[ i ].msc_info = mi;
 168         }
 169
 170         BER_BVZERO( &mc->mc_local_ndn );
 171         mc->msc_mscflags = 0;
 172         mc->mc_authz_target = META_BOUND_NONE;
 173         ldap_pvt_thread_mutex_init( &mc->mc_mutex );
 174         mc->mc_refcnt = 1;
 175         mc->mc_tainted = 0;
 176
 177         return mc;
 178 }
 179
 180 static void
 181 meta_back_freeconn(
 182         Operation       *op,
 183         metaconn_t      *mc )
 184 {
 185         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 186
 187         assert( mc != NULL );
 188
 189         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
 190
 191         if ( --mc->mc_refcnt == 0 ) {
 192                 meta_back_conn_free( mc );
 193         }
 194
 195         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 196 }
 197
 198 /*
 199  * meta_back_init_one_conn
 200  *
 201  * Initializes one connection
 202  */
 203 int
 204 meta_back_init_one_conn(
 205         Operation               *op,
 206         SlapReply               *rs,
 207         metatarget_t            *mt,
 208         metaconn_t              *mc,
 209         metasingleconn_t        *msc,
 210         int                     ispriv,
 211         int                     isauthz,
 212         ldap_back_send_t        sendok )
 213 {
 214         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 215         int             vers;
 216         dncookie        dc;
 217
 218         /*
 219          * Already init'ed
 220          */
 221         if ( msc->msc_ld != NULL ) {
 222                 return rs->sr_err = LDAP_SUCCESS;
 223         }
 224
 225         /*
 226          * Attempts to initialize the connection to the target ds
 227          */
 228         rs->sr_err = ldap_initialize( &msc->msc_ld, mt->mt_uri );
 229         if ( rs->sr_err != LDAP_SUCCESS ) {
 230                 goto error_return;
 231         }
 232
 233         /*
 234          * Set LDAP version. This will always succeed: If the client
 235          * bound with a particular version, then so can we.
 236          */
 237         vers = op->o_conn->c_protocol;
 238         ldap_set_option( msc->msc_ld, LDAP_OPT_PROTOCOL_VERSION, &vers );
 239
 240         /* automatically chase referrals ("chase-referrals"/"dont-chase-referrals" statement) */
 241         if ( LDAP_BACK_CHASE_REFERRALS( mi ) ) {
 242                 ldap_set_option( msc->msc_ld, LDAP_OPT_REFERRALS, LDAP_OPT_ON );
 243         }
 244
 245 #ifdef HAVE_TLS
 246         /* start TLS ("tls [try-]{start|propagate}" statement) */
 247         if ( ( LDAP_BACK_USE_TLS( mi ) || ( op->o_conn->c_is_tls && LDAP_BACK_PROPAGATE_TLS( mi ) ) )
 248                         && !ldap_is_ldaps_url( mt->mt_uri ) )
 249         {
 250 #ifdef SLAP_STARTTLS_ASYNCHRONOUS
 251                 /*
 252                  * use asynchronous StartTLS; in case, chase referral
 253                  * FIXME: OpenLDAP does not return referral on StartTLS yet
 254                  */
 255                 int             msgid;
 256
 257                 rs->sr_err = ldap_start_tls( msc->msc_ld, NULL, NULL, &msgid );
 258                 if ( rs->sr_err == LDAP_SUCCESS ) {
 259                         LDAPMessage     *res = NULL;
 260                         int             rc, nretries = mt->mt_nretries;
 261                         struct timeval  tv;
 262
 263                         LDAP_BACK_TV_SET( &tv );
 264
 265 retry:;
 266                         rc = ldap_result( msc->msc_ld, msgid, LDAP_MSG_ALL, &tv, &res );
 267                         if ( rc < 0 ) {
 268                                 rs->sr_err = LDAP_OTHER;
 269
 270                         } else if ( rc == 0 ) {
 271                                 if ( nretries != 0 ) {
 272                                         if ( nretries > 0 ) {
 273                                                 nretries--;
 274                                         }
 275                                         LDAP_BACK_TV_SET( &tv );
 276                                         goto retry;
 277                                 }
 278                                 rs->sr_err = LDAP_OTHER;
 279
 280                         } else if ( rc == LDAP_RES_EXTENDED ) {
 281                                 struct berval   *data = NULL;
 282
 283                                 rs->sr_err = ldap_parse_extended_result( msc->msc_ld, res,
 284                                                 NULL, &data, 0 );
 285                                 if ( rs->sr_err == LDAP_SUCCESS ) {
 286                                         int             err;
 287
 288                                         rs->sr_err = ldap_parse_result( msc->msc_ld, res,
 289                                                 &err, NULL, NULL, NULL, NULL, 1 );
 290                                         res = NULL;
 291
 292                                         if ( rs->sr_err == LDAP_SUCCESS ) {
 293                                                 rs->sr_err = err;
 294                                         }
 295
 296                                         /* FIXME: in case a referral
 297                                          * is returned, should we try
 298                                          * using it instead of the
 299                                          * configured URI? */
 300                                         if ( rs->sr_err == LDAP_SUCCESS ) {
 301                                                 ldap_install_tls( msc->msc_ld );
 302
 303                                         } else if ( rs->sr_err == LDAP_REFERRAL ) {
 304                                                 rs->sr_err = LDAP_OTHER;
 305                                                 rs->sr_text = "unwilling to chase referral returned by Start TLS exop";
 306                                         }
 307
 308                                         if ( data ) {
 309                                                 if ( data->bv_val ) {
 310                                                         ber_memfree( data->bv_val );
 311                                                 }
 312                                                 ber_memfree( data );
 313                                         }
 314                                 }
 315
 316                         } else {
 317                                 rs->sr_err = LDAP_OTHER;
 318                         }
 319
 320                         if ( res != NULL ) {
 321                                 ldap_msgfree( res );
 322                         }
 323                 }
 324 #else /* ! SLAP_STARTTLS_ASYNCHRONOUS */
 325                 /*
 326                  * use synchronous StartTLS
 327                  */
 328                 rs->sr_err = ldap_start_tls_s( msc->msc_ld, NULL, NULL );
 329 #endif /* ! SLAP_STARTTLS_ASYNCHRONOUS */
 330
 331                 /* if StartTLS is requested, only attempt it if the URL
 332                  * is not "ldaps://"; this may occur not only in case
 333                  * of misconfiguration, but also when used in the chain
 334                  * overlay, where the "uri" can be parsed out of a referral */
 335                 if ( rs->sr_err == LDAP_SERVER_DOWN
 336                                 || ( rs->sr_err != LDAP_SUCCESS && LDAP_BACK_TLS_CRITICAL( mi ) ) )
 337                 {
 338                         ldap_unbind_ext_s( msc->msc_ld, NULL, NULL );
 339                         goto error_return;
 340                 }
 341         }
 342 #endif /* HAVE_TLS */
 343
 344         /*
 345          * Set the network timeout if set
 346          */
 347         if ( mi->mi_network_timeout != 0 ) {
 348                 struct timeval  network_timeout;
 349
 350                 network_timeout.tv_usec = 0;
 351                 network_timeout.tv_sec = mi->mi_network_timeout;
 352
 353                 ldap_set_option( msc->msc_ld, LDAP_OPT_NETWORK_TIMEOUT,
 354                                 (void *)&network_timeout );
 355         }
 356
 357         /*
 358          * If the connection DN is not null, an attempt to rewrite it is made
 359          */
 360
 361         if ( ispriv ) {
 362                 if ( !BER_BVISNULL( &mt->mt_pseudorootdn ) ) {
 363                         ber_dupbv( &msc->msc_bound_ndn, &mt->mt_pseudorootdn );
 364                         if ( !BER_BVISNULL( &mt->mt_pseudorootpw ) ) {
 365                                 ber_dupbv( &msc->msc_cred, &mt->mt_pseudorootpw );
 366                         }
 367
 368                 } else {
 369                         ber_str2bv( "", 0, 1, &msc->msc_bound_ndn );
 370                 }
 371
 372                 LDAP_BACK_CONN_ISPRIV_SET( msc );
 373
 374         } else {
 375                 BER_BVZERO( &msc->msc_cred );
 376                 BER_BVZERO( &msc->msc_bound_ndn );
 377                 if ( !BER_BVISEMPTY( &op->o_ndn )
 378                         && SLAP_IS_AUTHZ_BACKEND( op )
 379                         && isauthz )
 380                 {
 381                         dc.target = mt;
 382                         dc.conn = op->o_conn;
 383                         dc.rs = rs;
 384                         dc.ctx = "bindDN";
 385
 386                         /*
 387                          * Rewrite the bind dn if needed
 388                          */
 389                         if ( ldap_back_dn_massage( &dc, &op->o_conn->c_dn,
 390                                                 &msc->msc_bound_ndn ) )
 391                         {
 392                                 ldap_unbind_ext_s( msc->msc_ld, NULL, NULL );
 393                                 goto error_return;
 394                         }
 395
 396                         /* copy the DN idf needed */
 397                         if ( msc->msc_bound_ndn.bv_val == op->o_conn->c_dn.bv_val ) {
 398                                 ber_dupbv( &msc->msc_bound_ndn, &op->o_conn->c_dn );
 399                         }
 400
 401                 } else {
 402                         ber_str2bv( "", 0, 1, &msc->msc_bound_ndn );
 403                 }
 404         }
 405
 406         assert( !BER_BVISNULL( &msc->msc_bound_ndn ) );
 407
 408         LDAP_BACK_CONN_ISBOUND_CLEAR( msc );
 409
 410 error_return:;
 411         if ( rs->sr_err == LDAP_SUCCESS ) {
 412                 /*
 413                  * Sets a cookie for the rewrite session
 414                  */
 415                 ( void )rewrite_session_init( mt->mt_rwmap.rwm_rw, op->o_conn );
 416
 417         } else {
 418                 rs->sr_err = slap_map_api2result( rs );
 419                 if ( sendok & LDAP_BACK_SENDERR ) {
 420                         send_ldap_result( op, rs );
 421                         rs->sr_text = NULL;
 422                 }
 423         }
 424
 425         return rs->sr_err;
 426 }
 427
 428 /*
 429  * meta_back_retry
 430  *
 431  * Retries one connection
 432  */
 433 int
 434 meta_back_retry(
 435         Operation               *op,
 436         SlapReply               *rs,
 437         metaconn_t              *mc,
 438         int                     candidate,
 439         ldap_back_send_t        sendok )
 440 {
 441         metainfo_t              *mi = ( metainfo_t * )op->o_bd->be_private;
 442         metatarget_t            *mt = &mi->mi_targets[ candidate ];
 443         int                     rc = LDAP_UNAVAILABLE;
 444         metasingleconn_t        *msc = &mc->mc_conns[ candidate ];
 445
 446 retry_lock:;
 447         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
 448
 449         assert( mc->mc_refcnt > 0 );
 450
 451         if ( mc->mc_refcnt == 1 ) {
 452                 while ( ldap_pvt_thread_mutex_trylock( &mc->mc_mutex ) ) {
 453                         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 454                         ldap_pvt_thread_yield();
 455                         goto retry_lock;
 456                 }
 457
 458                 Debug( LDAP_DEBUG_ANY,
 459                         "%s meta_back_retry: retrying URI=\"%s\" DN=\"%s\"\n",
 460                         op->o_log_prefix, mt->mt_uri,
 461                         BER_BVISNULL( &msc->msc_bound_ndn ) ?
 462                                 "" : msc->msc_bound_ndn.bv_val );
 463
 464                 meta_clear_one_candidate( msc );
 465                 LDAP_BACK_CONN_ISBOUND_CLEAR( msc );
 466
 467                 ( void )rewrite_session_delete( mt->mt_rwmap.rwm_rw, op->o_conn );
 468
 469                 /* mc here must be the regular mc, reset and ready for init */
 470                 rc = meta_back_init_one_conn( op, rs, mt, mc, msc,
 471                         LDAP_BACK_CONN_ISPRIV( mc ),
 472                         candidate == mc->mc_authz_target, sendok );
 473
 474                 if ( rc == LDAP_SUCCESS ) {
 475                         rc = meta_back_single_dobind( op, rs, mc, candidate,
 476                                         sendok, mt->mt_nretries, 0 );
 477                 }
 478
 479                 ldap_pvt_thread_mutex_unlock( &mc->mc_mutex );
 480         }
 481
 482         if ( rc != LDAP_SUCCESS ) {
 483                 mc->mc_tainted = 1;
 484         }
 485
 486         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 487
 488         return rc == LDAP_SUCCESS ? 1 : 0;
 489 }
 490
 491 /*
 492  * callback for unique candidate selection
 493  */
 494 static int
 495 meta_back_conn_cb( Operation *op, SlapReply *rs )
 496 {
 497         assert( op->o_tag == LDAP_REQ_SEARCH );
 498
 499         switch ( rs->sr_type ) {
 500         case REP_SEARCH:
 501                 ((long *)op->o_callback->sc_private)[0] = (long)op->o_private;
 502                 break;
 503
 504         case REP_SEARCHREF:
 505         case REP_RESULT:
 506                 break;
 507
 508         default:
 509                 return rs->sr_err;
 510         }
 511
 512         return 0;
 513 }
 514
 515
 516 static int
 517 meta_back_get_candidate(
 518         Operation       *op,
 519         SlapReply       *rs,
 520         struct berval   *ndn )
 521 {
 522         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 523         long            candidate;
 524
 525         /*
 526          * tries to get a unique candidate
 527          * (takes care of default target)
 528          */
 529         candidate = meta_back_select_unique_candidate( mi, ndn );
 530
 531         /*
 532          * if any is found, inits the connection
 533          */
 534         if ( candidate == META_TARGET_NONE ) {
 535                 rs->sr_err = LDAP_NO_SUCH_OBJECT;
 536                 rs->sr_text = "no suitable candidate target found";
 537
 538         } else if ( candidate == META_TARGET_MULTIPLE ) {
 539                 Filter          f = { 0 };
 540                 Operation       op2 = *op;
 541                 SlapReply       rs2 = { 0 };
 542                 slap_callback   cb2 = { 0 };
 543                 int             rc;
 544
 545                 /* try to get a unique match for the request ndn
 546                  * among the multiple candidates available */
 547                 op2.o_tag = LDAP_REQ_SEARCH;
 548                 op2.o_req_dn = *ndn;
 549                 op2.o_req_ndn = *ndn;
 550                 op2.ors_scope = LDAP_SCOPE_BASE;
 551                 op2.ors_deref = LDAP_DEREF_NEVER;
 552                 op2.ors_attrs = slap_anlist_no_attrs;
 553                 op2.ors_attrsonly = 0;
 554                 op2.ors_limit = NULL;
 555                 op2.ors_slimit = 1;
 556                 op2.ors_tlimit = SLAP_NO_LIMIT;
 557
 558                 f.f_choice = LDAP_FILTER_PRESENT;
 559                 f.f_desc = slap_schema.si_ad_objectClass;
 560                 op2.ors_filter = &f;
 561                 BER_BVSTR( &op2.ors_filterstr, "(objectClass=*)" );
 562
 563                 op2.o_callback = &cb2;
 564                 cb2.sc_response = meta_back_conn_cb;
 565                 cb2.sc_private = (void *)&candidate;
 566
 567                 rc = op->o_bd->be_search( &op2, &rs2 );
 568
 569                 switch ( rs2.sr_err ) {
 570                 case LDAP_SUCCESS:
 571                 default:
 572                         rs->sr_err = rs2.sr_err;
 573                         break;
 574
 575                 case LDAP_SIZELIMIT_EXCEEDED:
 576                         /* if multiple candidates can serve the operation,
 577                          * and a default target is defined, and it is
 578                          * a candidate, try using it (FIXME: YMMV) */
 579                         if ( mi->mi_defaulttarget != META_DEFAULT_TARGET_NONE
 580                                 && meta_back_is_candidate( &mi->mi_targets[ mi->mi_defaulttarget ].mt_nsuffix,
 581                                                 mi->mi_targets[ mi->mi_defaulttarget ].mt_scope,
 582                                                 ndn, op->o_tag == LDAP_REQ_SEARCH ? op->ors_scope : LDAP_SCOPE_BASE ) )
 583                         {
 584                                 candidate = mi->mi_defaulttarget;
 585                                 rs->sr_err = LDAP_SUCCESS;
 586                                 rs->sr_text = NULL;
 587
 588                         } else {
 589                                 rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
 590                                 rs->sr_text = "cannot select unique candidate target";
 591                         }
 592                         break;
 593                 }
 594
 595         } else {
 596                 rs->sr_err = LDAP_SUCCESS;
 597         }
 598
 599         return candidate;
 600 }
 601
 602 static void     *meta_back_candidates_dummy;
 603
 604 static void
 605 meta_back_candidates_keyfree(
 606         void            *key,
 607         void            *data )
 608 {
 609         metacandidates_t        *mc = (metacandidates_t *)data;
 610
 611         ber_memfree_x( mc->mc_candidates, NULL );
 612         ber_memfree_x( data, NULL );
 613 }
 614
 615 SlapReply *
 616 meta_back_candidates_get( Operation *op )
 617 {
 618         metainfo_t              *mi = ( metainfo_t * )op->o_bd->be_private;
 619         metacandidates_t        *mc;
 620
 621         if ( op->o_threadctx ) {
 622                 void            *data = NULL;
 623
 624                 ldap_pvt_thread_pool_getkey( op->o_threadctx,
 625                                 &meta_back_candidates_dummy, &data, NULL );
 626                 mc = (metacandidates_t *)data;
 627
 628         } else {
 629                 mc = mi->mi_candidates;
 630         }
 631
 632         if ( mc == NULL ) {
 633                 mc = ch_calloc( sizeof( metacandidates_t ), 1 );
 634                 mc->mc_ntargets = mi->mi_ntargets;
 635                 mc->mc_candidates = ch_calloc( sizeof( SlapReply ), mc->mc_ntargets );
 636                 if ( op->o_threadctx ) {
 637                         void            *data = NULL;
 638
 639                         data = (void *)mc;
 640                         ldap_pvt_thread_pool_setkey( op->o_threadctx,
 641                                         &meta_back_candidates_dummy, data,
 642                                         meta_back_candidates_keyfree );
 643
 644                 } else {
 645                         mi->mi_candidates = mc;
 646                 }
 647
 648         } else if ( mc->mc_ntargets < mi->mi_ntargets ) {
 649                 /* NOTE: in the future, may want to allow back-config
 650                  * to add/remove targets from back-meta... */
 651                 mc->mc_ntargets = mi->mi_ntargets;
 652                 mc->mc_candidates = ch_realloc( mc->mc_candidates,
 653                                 sizeof( SlapReply ) * mc->mc_ntargets );
 654         }
 655
 656         return mc->mc_candidates;
 657 }
 658
 659 /*
 660  * meta_back_getconn
 661  *
 662  * Prepares the connection structure
 663  *
 664  * RATIONALE:
 665  *
 666  * - determine what DN is being requested:
 667  *
 668  *      op      requires candidate      checks
 669  *
 670  *      add     unique                  parent of o_req_ndn
 671  *      bind    unique^*[/all]          o_req_ndn [no check]
 672  *      compare unique^+                o_req_ndn
 673  *      delete  unique                  o_req_ndn
 674  *      modify  unique                  o_req_ndn
 675  *      search  any                     o_req_ndn
 676  *      modrdn  unique[, unique]        o_req_ndn[, orr_nnewSup]
 677  *
 678  * - for ops that require the candidate to be unique, in case of multiple
 679  *   occurrences an internal search with sizeLimit=1 is performed
 680  *   if a unique candidate can actually be determined.  If none is found,
 681  *   the operation aborts; if multiple are found, the default target
 682  *   is used if defined and candidate; otherwise the operation aborts.
 683  *
 684  * *^note: actually, the bind operation is handled much like a search;
 685  *   i.e. the bind is broadcast to all candidate targets.
 686  *
 687  * +^note: actually, the compare operation is handled much like a search;
 688  *   i.e. the compare is broadcast to all candidate targets, while checking
 689  *   that exactly none (noSuchObject) or one (TRUE/FALSE/UNDEFINED) is
 690  *   returned.
 691  */
 692 metaconn_t *
 693 meta_back_getconn(
 694         Operation               *op,
 695         SlapReply               *rs,
 696         int                     *candidate,
 697         ldap_back_send_t        sendok )
 698 {
 699         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
 700         metaconn_t      *mc = NULL,
 701                         mc_curr = { 0 };
 702         int             cached = META_TARGET_NONE,
 703                         i = META_TARGET_NONE,
 704                         err = LDAP_SUCCESS,
 705                         new_conn = 0,
 706                         ncandidates = 0;
 707
 708
 709         meta_op_type    op_type = META_OP_REQUIRE_SINGLE;
 710         int             parent = 0,
 711                         newparent = 0;
 712         struct berval   ndn = op->o_req_ndn,
 713                         pndn;
 714
 715         SlapReply       *candidates = meta_back_candidates_get( op );
 716
 717         /* Internal searches are privileged and shared. So is root. */
 718         /* FIXME: there seem to be concurrency issues */
 719         if ( op->o_do_not_cache || be_isroot( op ) ) {
 720                 mc_curr.mc_local_ndn = op->o_bd->be_rootndn;
 721                 LDAP_BACK_CONN_ISPRIV_SET( &mc_curr );
 722                 mc_curr.mc_conn = LDAP_BACK_PCONN_SET( op );
 723
 724         } else {
 725                 mc_curr.mc_local_ndn = op->o_ndn;
 726
 727                 /* Explicit binds must not be shared */
 728                 if ( op->o_tag == LDAP_REQ_BIND || SLAP_IS_AUTHZ_BACKEND( op ) ) {
 729                         mc_curr.mc_conn = op->o_conn;
 730
 731                 } else {
 732                         mc_curr.mc_conn = LDAP_BACK_PCONN_SET( op );
 733                 }
 734         }
 735
 736         /* Searches for a metaconn in the avl tree */
 737         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
 738         mc = (metaconn_t *)avl_find( mi->mi_conntree,
 739                 (caddr_t)&mc_curr, meta_back_conn_cmp );
 740         if ( mc ) {
 741                 if ( mc->mc_tainted ) {
 742                         rs->sr_err = LDAP_UNAVAILABLE;
 743                         rs->sr_text = "remote server unavailable";
 744                         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 745                         return NULL;
 746                 }
 747
 748                 mc->mc_refcnt++;
 749         }
 750         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 751
 752         switch ( op->o_tag ) {
 753         case LDAP_REQ_ADD:
 754                 /* if we go to selection, the entry must not exist,
 755                  * and we must be able to resolve the parent */
 756                 parent = 1;
 757                 dnParent( &ndn, &pndn );
 758                 break;
 759
 760         case LDAP_REQ_MODRDN:
 761                 /* if nnewSuperior is not NULL, it must resolve
 762                  * to the same candidate as the req_ndn */
 763                 if ( op->orr_nnewSup ) {
 764                         newparent = 1;
 765                 }
 766                 break;
 767
 768         case LDAP_REQ_BIND:
 769                 /* if bound as rootdn, the backend must bind to all targets
 770                  * with the administrative identity */
 771                 if ( op->orb_method == LDAP_AUTH_SIMPLE && be_isroot_pw( op ) ) {
 772                         op_type = META_OP_REQUIRE_ALL;
 773                 }
 774                 break;
 775
 776         case LDAP_REQ_DELETE:
 777         case LDAP_REQ_MODIFY:
 778                 /* just a unique candidate */
 779                 break;
 780
 781         case LDAP_REQ_COMPARE:
 782         case LDAP_REQ_SEARCH:
 783                 /* allow multiple candidates for the searchBase */
 784                 op_type = META_OP_ALLOW_MULTIPLE;
 785                 break;
 786
 787         default:
 788                 /* right now, just break (exop?) */
 789                 break;
 790         }
 791
 792         /*
 793          * require all connections ...
 794          */
 795         if ( op_type == META_OP_REQUIRE_ALL ) {
 796
 797                 /* Looks like we didn't get a bind. Open a new session... */
 798                 if ( mc == NULL ) {
 799                         mc = metaconn_alloc( op );
 800                         mc->mc_conn = mc_curr.mc_conn;
 801                         ber_dupbv( &mc->mc_local_ndn, &mc_curr.mc_local_ndn );
 802                         new_conn = 1;
 803                 }
 804
 805                 for ( i = 0; i < mi->mi_ntargets; i++ ) {
 806                         metatarget_t            *mt = &mi->mi_targets[ i ];
 807                         metasingleconn_t        *msc = &mc->mc_conns[ i ];
 808
 809                         /*
 810                          * The target is activated; if needed, it is
 811                          * also init'd
 812                          */
 813                         candidates[ i ].sr_err = meta_back_init_one_conn( op,
 814                                 rs, mt, mc, msc,
 815                                 LDAP_BACK_CONN_ISPRIV( &mc_curr ),
 816                                 i == mc->mc_authz_target, sendok );
 817                         if ( candidates[ i ].sr_err == LDAP_SUCCESS ) {
 818                                 candidates[ i ].sr_tag = META_CANDIDATE;
 819                                 ncandidates++;
 820
 821                         } else {
 822
 823                                 /*
 824                                  * FIXME: in case one target cannot
 825                                  * be init'd, should the other ones
 826                                  * be tried?
 827                                  */
 828                                 candidates[ i ].sr_tag = META_NOT_CANDIDATE;
 829                                 err = candidates[ i ].sr_err;
 830                                 continue;
 831                         }
 832                 }
 833
 834                 if ( ncandidates == 0 ) {
 835                         if ( new_conn ) {
 836                                 meta_back_freeconn( op, mc );
 837
 838                         } else {
 839                                 meta_back_release_conn( op, mc );
 840                         }
 841
 842                         rs->sr_err = LDAP_NO_SUCH_OBJECT;
 843                         rs->sr_text = "Unable to select valid candidates";
 844
 845                         if ( sendok & LDAP_BACK_SENDERR ) {
 846                                 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
 847                                         rs->sr_matched = op->o_bd->be_suffix[ 0 ].bv_val;
 848                                 }
 849                                 send_ldap_result( op, rs );
 850                                 rs->sr_text = NULL;
 851                                 rs->sr_matched = NULL;
 852                         }
 853
 854                         return NULL;
 855                 }
 856
 857                 goto done;
 858         }
 859
 860         /*
 861          * looks in cache, if any
 862          */
 863         if ( mi->mi_cache.ttl != META_DNCACHE_DISABLED ) {
 864                 cached = i = meta_dncache_get_target( &mi->mi_cache, &op->o_req_ndn );
 865         }
 866
 867         if ( op_type == META_OP_REQUIRE_SINGLE ) {
 868                 metatarget_t            *mt = NULL;
 869                 metasingleconn_t        *msc = NULL;
 870
 871                 int                     j;
 872
 873                 for ( j = 0; j < mi->mi_ntargets; j++ ) {
 874                         candidates[ j ].sr_tag = META_NOT_CANDIDATE;
 875                 }
 876
 877                 /*
 878                  * tries to get a unique candidate
 879                  * (takes care of default target)
 880                  */
 881                 if ( i == META_TARGET_NONE ) {
 882                         i = meta_back_get_candidate( op, rs, &ndn );
 883
 884                         if ( rs->sr_err == LDAP_NO_SUCH_OBJECT && parent ) {
 885                                 i = meta_back_get_candidate( op, rs, &pndn );
 886                         }
 887
 888                         if ( rs->sr_err != LDAP_SUCCESS ) {
 889                                 if ( mc != NULL ) {
 890                                         meta_back_release_conn( op, mc );
 891                                 }
 892
 893                                 if ( sendok & LDAP_BACK_SENDERR ) {
 894                                         if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
 895                                                 rs->sr_matched = op->o_bd->be_suffix[ 0 ].bv_val;
 896                                         }
 897                                         send_ldap_result( op, rs );
 898                                         rs->sr_text = NULL;
 899                                         rs->sr_matched = NULL;
 900                                 }
 901
 902                                 return NULL;
 903                         }
 904                 }
 905
 906                 if ( newparent && meta_back_get_candidate( op, rs, op->orr_nnewSup ) != i )
 907                 {
 908                         if ( mc != NULL ) {
 909                                 meta_back_release_conn( op, mc );
 910                         }
 911
 912                         rs->sr_err = LDAP_UNWILLING_TO_PERFORM;
 913                         rs->sr_text = "cross-target rename not supported";
 914                         if ( sendok & LDAP_BACK_SENDERR ) {
 915                                 send_ldap_result( op, rs );
 916                                 rs->sr_text = NULL;
 917                         }
 918
 919                         return NULL;
 920                 }
 921
 922                 Debug( LDAP_DEBUG_TRACE,
 923         "==>meta_back_getconn: got target %d for ndn=\"%s\" from cache\n",
 924                                 i, op->o_req_ndn.bv_val, 0 );
 925
 926                 if ( mc == NULL ) {
 927                         /* Retries searching for a metaconn in the avl tree
 928                          * the reason is that the connection might have been
 929                          * created by meta_back_get_candidate() */
 930                         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
 931                         mc = (metaconn_t *)avl_find( mi->mi_conntree,
 932                                 (caddr_t)&mc_curr, meta_back_conn_cmp );
 933                         if ( mc != NULL ) {
 934                                 mc->mc_refcnt++;
 935                         }
 936                         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
 937
 938                         /* Looks like we didn't get a bind. Open a new session... */
 939                         if ( mc == NULL ) {
 940                                 mc = metaconn_alloc( op );
 941                                 mc->mc_conn = mc_curr.mc_conn;
 942                                 ber_dupbv( &mc->mc_local_ndn, &mc_curr.mc_local_ndn );
 943                                 new_conn = 1;
 944                         }
 945                 }
 946
 947                 /*
 948                  * Clear all other candidates
 949                  */
 950                 ( void )meta_clear_unused_candidates( op, i );
 951
 952                 mt = &mi->mi_targets[ i ];
 953                 msc = &mc->mc_conns[ i ];
 954
 955                 /*
 956                  * The target is activated; if needed, it is
 957                  * also init'd. In case of error, meta_back_init_one_conn
 958                  * sends the appropriate result.
 959                  */
 960                 err = meta_back_init_one_conn( op, rs, mt, mc, msc,
 961                         LDAP_BACK_CONN_ISPRIV( &mc_curr ),
 962                         i == mc->mc_authz_target, sendok );
 963                 if ( err != LDAP_SUCCESS ) {
 964                         /*
 965                          * FIXME: in case one target cannot
 966                          * be init'd, should the other ones
 967                          * be tried?
 968                          */
 969                         candidates[ i ].sr_tag = META_NOT_CANDIDATE;
 970                         if ( new_conn ) {
 971                                 (void)meta_clear_one_candidate( msc );
 972                                 meta_back_freeconn( op, mc );
 973
 974                         } else {
 975                                 meta_back_release_conn( op, mc );
 976                         }
 977                         return NULL;
 978                 }
 979
 980                 candidates[ i ].sr_err = LDAP_SUCCESS;
 981                 candidates[ i ].sr_tag = META_CANDIDATE;
 982                 ncandidates++;
 983
 984                 if ( candidate ) {
 985                         *candidate = i;
 986                 }
 987
 988         /*
 989          * if no unique candidate ...
 990          */
 991         } else {
 992
 993                 /* Looks like we didn't get a bind. Open a new session... */
 994                 if ( mc == NULL ) {
 995                         mc = metaconn_alloc( op );
 996                         mc->mc_conn = mc_curr.mc_conn;
 997                         ber_dupbv( &mc->mc_local_ndn, &mc_curr.mc_local_ndn );
 998                         new_conn = 1;
 999                 }
1000
1001                 for ( i = 0; i < mi->mi_ntargets; i++ ) {
1002                         metatarget_t            *mt = &mi->mi_targets[ i ];
1003                         metasingleconn_t        *msc = &mc->mc_conns[ i ];
1004
1005                         if ( i == cached
1006                                 || meta_back_is_candidate( &mt->mt_nsuffix,
1007                                                 mt->mt_scope,
1008                                                 &op->o_req_ndn,
1009                                                 LDAP_SCOPE_SUBTREE ) )
1010                         {
1011
1012                                 /*
1013                                  * The target is activated; if needed, it is
1014                                  * also init'd
1015                                  */
1016                                 int lerr = meta_back_init_one_conn( op, rs,
1017                                                 mt, mc, msc,
1018                                                 LDAP_BACK_CONN_ISPRIV( &mc_curr ),
1019                                                 i == mc->mc_authz_target,
1020                                                 sendok );
1021                                 if ( lerr == LDAP_SUCCESS ) {
1022                                         candidates[ i ].sr_tag = META_CANDIDATE;
1023                                         candidates[ i ].sr_err = LDAP_SUCCESS;
1024                                         ncandidates++;
1025
1026                                         Debug( LDAP_DEBUG_TRACE, "%s: meta_back_init_one_conn(%d)\n",
1027                                                 op->o_log_prefix, i, 0 );
1028
1029                                 } else {
1030
1031                                         /*
1032                                          * FIXME: in case one target cannot
1033                                          * be init'd, should the other ones
1034                                          * be tried?
1035                                          */
1036                                         if ( new_conn ) {
1037                                                 ( void )meta_clear_one_candidate( msc );
1038                                         }
1039                                         /* leave the target candidate, but record the error for later use */
1040                                         candidates[ i ].sr_err = lerr;
1041                                         err = lerr;
1042
1043                                         Debug( LDAP_DEBUG_ANY, "%s: meta_back_init_one_conn(%d) failed: %d\n",
1044                                                 op->o_log_prefix, i, lerr );
1045
1046                                         continue;
1047                                 }
1048
1049                         } else {
1050                                 if ( new_conn ) {
1051                                         ( void )meta_clear_one_candidate( msc );
1052                                 }
1053                                 candidates[ i ].sr_tag = META_NOT_CANDIDATE;
1054                         }
1055                 }
1056
1057                 if ( ncandidates == 0 ) {
1058                         if ( new_conn ) {
1059                                 meta_back_freeconn( op, mc );
1060
1061                         } else {
1062                                 meta_back_release_conn( op, mc );
1063                         }
1064
1065                         rs->sr_err = LDAP_NO_SUCH_OBJECT;
1066                         rs->sr_text = "Unable to select valid candidates";
1067
1068                         if ( sendok & LDAP_BACK_SENDERR ) {
1069                                 if ( rs->sr_err == LDAP_NO_SUCH_OBJECT ) {
1070                                         rs->sr_matched = op->o_bd->be_suffix[ 0 ].bv_val;
1071                                 }
1072                                 send_ldap_result( op, rs );
1073                                 rs->sr_text = NULL;
1074                                 rs->sr_matched = NULL;
1075                         }
1076
1077                         return NULL;
1078                 }
1079         }
1080
1081 done:;
1082         /* clear out meta_back_init_one_conn non-fatal errors */
1083         rs->sr_err = LDAP_SUCCESS;
1084         rs->sr_text = NULL;
1085
1086         if ( new_conn ) {
1087
1088                 /*
1089                  * Inserts the newly created metaconn in the avl tree
1090                  */
1091                 ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
1092                 err = avl_insert( &mi->mi_conntree, ( caddr_t )mc,
1093                                 meta_back_conn_cmp, meta_back_conn_dup );
1094
1095 #if PRINT_CONNTREE > 0
1096                 myprint( mi->mi_conntree );
1097 #endif /* PRINT_CONNTREE */
1098
1099                 ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
1100
1101                 /*
1102                  * Err could be -1 in case a duplicate metaconn is inserted
1103                  *
1104                  * FIXME: what if the same client issues more than one
1105                  * asynchronous operations?
1106                  */
1107                 if ( err != 0 ) {
1108                         Debug( LDAP_DEBUG_ANY,
1109                                 "%s meta_back_getconn: candidates=%d conn=%ld insert failed\n",
1110                                 op->o_log_prefix, ncandidates,
1111                                 LDAP_BACK_PCONN_ID( mc->mc_conn ) );
1112
1113                         rs->sr_err = LDAP_OTHER;
1114                         rs->sr_text = "Internal server error";
1115                         meta_back_freeconn( op, mc );
1116                         if ( sendok & LDAP_BACK_SENDERR ) {
1117                                 send_ldap_result( op, rs );
1118                                 rs->sr_text = NULL;
1119                         }
1120                         return NULL;
1121                 }
1122
1123                 Debug( LDAP_DEBUG_TRACE,
1124                         "%s meta_back_getconn: candidates=%d conn=%ld inserted\n",
1125                         op->o_log_prefix, ncandidates,
1126                         LDAP_BACK_PCONN_ID( mc->mc_conn ) );
1127
1128         } else {
1129                 Debug( LDAP_DEBUG_TRACE,
1130                         "%s meta_back_getconn: candidates=%d conn=%ld fetched\n",
1131                         op->o_log_prefix, ncandidates,
1132                         LDAP_BACK_PCONN_ID( mc->mc_conn ) );
1133         }
1134
1135         return mc;
1136 }
1137
1138 void
1139 meta_back_release_conn(
1140         Operation               *op,
1141         metaconn_t              *mc )
1142 {
1143         metainfo_t      *mi = ( metainfo_t * )op->o_bd->be_private;
1144
1145         assert( mc != NULL );
1146
1147         ldap_pvt_thread_mutex_lock( &mi->mi_conn_mutex );
1148         assert( mc->mc_refcnt > 0 );
1149         mc->mc_refcnt--;
1150         if ( mc->mc_refcnt == 0 && mc->mc_tainted ) {
1151                 (void)avl_delete( &mi->mi_conntree, ( caddr_t )mc,
1152                                 meta_back_conn_cmp );
1153                 meta_back_conn_free( mc );
1154         }
1155         ldap_pvt_thread_mutex_unlock( &mi->mi_conn_mutex );
1156 }