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