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

   1 /*
   2  * Copyright 1998-2003 The OpenLDAP Foundation, All Rights Reserved.
   3  * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
   4  *
   5  * Copyright 2001, Pierangelo Masarati, All rights reserved. <ando@sys-net.it>
   6  *
   7  * This work has been developed to fulfill the requirements
   8  * of SysNet s.n.c. <http:www.sys-net.it> and it has been donated
   9  * to the OpenLDAP Foundation in the hope that it may be useful
  10  * to the Open Source community, but WITHOUT ANY WARRANTY.
  11  *
  12  * Permission is granted to anyone to use this software for any purpose
  13  * on any computer system, and to alter it and redistribute it, subject
  14  * to the following restrictions:
  15  *
  16  * 1. The author and SysNet s.n.c. are not responsible for the consequences
  17  *    of use of this software, no matter how awful, even if they arise from
  18  *    flaws in it.
  19  *
  20  * 2. The origin of this software must not be misrepresented, either by
  21  *    explicit claim or by omission.  Since few users ever read sources,
  22  *    credits should appear in the documentation.
  23  *
  24  * 3. Altered versions must be plainly marked as such, and must not be
  25  *    misrepresented as being the original software.  Since few users
  26  *    ever read sources, credits should appear in the documentation.
  27  *    SysNet s.n.c. cannot be responsible for the consequences of the
  28  *    alterations.
  29  *
  30  * 4. This notice may not be removed or altered.
  31  *
  32  *
  33  * This software is based on the backend back-ldap, implemented
  34  * by Howard Chu <hyc@highlandsun.com>, and modified by Mark Valence
  35  * <kurash@sassafras.com>, Pierangelo Masarati <ando@sys-net.it> and other
  36  * contributors. The contribution of the original software to the present
  37  * implementation is acknowledged in this copyright statement.
  38  *
  39  * A special acknowledgement goes to Howard for the overall architecture
  40  * (and for borrowing large pieces of code), and to Mark, who implemented
  41  * from scratch the attribute/objectclass mapping.
  42  *
  43  * The original copyright statement follows.
  44  *
  45  * Copyright 1999, Howard Chu, All rights reserved. <hyc@highlandsun.com>
  46  *
  47  * Permission is granted to anyone to use this software for any purpose
  48  * on any computer system, and to alter it and redistribute it, subject
  49  * to the following restrictions:
  50  *
  51  * 1. The author is not responsible for the consequences of use of this
  52  *    software, no matter how awful, even if they arise from flaws in it.
  53  *
  54  * 2. The origin of this software must not be misrepresented, either by
  55  *    explicit claim or by omission.  Since few users ever read sources,
  56  *    credits should appear in the documentation.
  57  *
  58  * 3. Altered versions must be plainly marked as such, and must not be
  59  *    misrepresented as being the original software.  Since few users
  60  *    ever read sources, credits should appear in the
  61  *    documentation.
  62  *
  63  * 4. This notice may not be removed or altered.
  64  *
  65  */
  66
  67 #include "portable.h"
  68
  69 #include <stdio.h>
  70
  71 #include <ac/socket.h>
  72 #include <ac/string.h>
  73
  74
  75 #define AVL_INTERNAL
  76 #include "slap.h"
  77 #include "../back-ldap/back-ldap.h"
  78 #include "back-meta.h"
  79
  80 /*
  81  * Set PRINT_CONNTREE larger than 0 to dump the connection tree (debug only)
  82  */
  83 #define PRINT_CONNTREE 0
  84
  85 /*
  86  * meta_back_conn_cmp
  87  *
  88  * compares two struct metaconn based on the value of the conn pointer;
  89  * used by avl stuff
  90  */
  91 int
  92 meta_back_conn_cmp(
  93         const void *c1,
  94         const void *c2
  95         )
  96 {
  97         struct metaconn *lc1 = ( struct metaconn * )c1;
  98         struct metaconn *lc2 = ( struct metaconn * )c2;
  99
 100         return ( ( lc1->conn < lc2->conn ) ? -1 :
 101                         ( ( lc1->conn > lc2-> conn ) ? 1 : 0 ) );
 102 }
 103
 104 /*
 105  * meta_back_conn_dup
 106  *
 107  * returns -1 in case a duplicate struct metaconn has been inserted;
 108  * used by avl stuff
 109  */
 110 int
 111 meta_back_conn_dup(
 112         void *c1,
 113         void *c2
 114         )
 115 {
 116         struct metaconn *lc1 = ( struct metaconn * )c1;
 117         struct metaconn *lc2 = ( struct metaconn * )c2;
 118
 119         return( ( lc1->conn == lc2->conn ) ? -1 : 0 );
 120 }
 121
 122 /*
 123  * Debug stuff (got it from libavl)
 124  */
 125 #if PRINT_CONNTREE > 0
 126 static void
 127 ravl_print( Avlnode *root, int depth )
 128 {
 129         int     i;
 130
 131         if ( root == 0 ) {
 132                 return;
 133         }
 134
 135         ravl_print( root->avl_right, depth+1 );
 136
 137         for ( i = 0; i < depth; i++ ) {
 138                 printf( "    " );
 139         }
 140
 141         printf( "c(%d) %d\n", ( ( struct metaconn * )root->avl_data )->conn->c_connid, root->avl_bf );
 142
 143         ravl_print( root->avl_left, depth+1 );
 144 }
 145
 146 static void
 147 myprint( Avlnode *root )
 148 {
 149         printf( "********\n" );
 150
 151         if ( root == 0 ) {
 152                 printf( "\tNULL\n" );
 153         } else {
 154                 ravl_print( root, 0 );
 155         }
 156
 157         printf( "********\n" );
 158 }
 159 #endif /* PRINT_CONNTREE */
 160 /*
 161  * End of debug stuff
 162  */
 163
 164 /*
 165  * metaconn_alloc
 166  *
 167  * Allocates a connection structure, making room for all the referenced targets
 168  */
 169 static struct metaconn *
 170 metaconn_alloc( int ntargets )
 171 {
 172         struct metaconn *lc;
 173
 174         assert( ntargets > 0 );
 175
 176         lc = ch_calloc( sizeof( struct metaconn ), 1 );
 177         if ( lc == NULL ) {
 178                 return NULL;
 179         }
 180
 181         /*
 182          * make it a null-terminated array ...
 183          */
 184         lc->conns = ch_calloc( sizeof( struct metasingleconn ), ntargets+1 );
 185         if ( lc->conns == NULL ) {
 186                 free( lc );
 187                 return NULL;
 188         }
 189         lc->conns[ ntargets ].candidate = META_LAST_CONN;
 190
 191         lc->bound_target = META_BOUND_NONE;
 192
 193         return lc;
 194 }
 195
 196 /*
 197  * metaconn_free
 198  *
 199  * clears a metaconn
 200  */
 201 static void
 202 metaconn_free(
 203                 struct metaconn *lc
 204 )
 205 {
 206         if ( !lc ) {
 207                 return;
 208         }
 209
 210         if ( lc->conns ) {
 211                 ch_free( lc->conns );
 212         }
 213
 214         free( lc );
 215 }
 216
 217 /*
 218  * init_one_conn
 219  *
 220  * Initializes one connection
 221  */
 222 static int
 223 init_one_conn(
 224                 Operation               *op,
 225                 SlapReply               *rs,
 226                 struct metatarget       *lt,
 227                 struct metasingleconn   *lsc
 228                 )
 229 {
 230         int             vers;
 231         dncookie        dc;
 232
 233         /*
 234          * Already init'ed
 235          */
 236         if ( lsc->ld != NULL ) {
 237                 return LDAP_SUCCESS;
 238         }
 239
 240         /*
 241          * Attempts to initialize the connection to the target ds
 242          */
 243         rs->sr_err = ldap_initialize( &lsc->ld, lt->uri );
 244         if ( rs->sr_err != LDAP_SUCCESS ) {
 245                 return ldap_back_map_result( rs );
 246         }
 247
 248         /*
 249          * Set LDAP version. This will always succeed: If the client
 250          * bound with a particular version, then so can we.
 251          */
 252         vers = op->o_conn->c_protocol;
 253         ldap_set_option( lsc->ld, LDAP_OPT_PROTOCOL_VERSION, &vers );
 254         /* FIXME: configurable? */
 255         ldap_set_option(lsc->ld, LDAP_OPT_REFERRALS, LDAP_OPT_ON);
 256
 257         /*
 258          * Sets a cookie for the rewrite session
 259          */
 260         ( void )rewrite_session_init( lt->rwmap.rwm_rw, op->o_conn );
 261
 262         /*
 263          * If the connection dn is not null, an attempt to rewrite it is made
 264          */
 265         if ( op->o_conn->c_dn.bv_len != 0 ) {
 266                 dc.rwmap = &lt->rwmap;
 267                 dc.conn = op->o_conn;
 268                 dc.rs = rs;
 269                 dc.ctx = "bindDn";
 270
 271                 /*
 272                  * Rewrite the bind dn if needed
 273                  */
 274                 if ( ldap_back_dn_massage( &dc, &op->o_conn->c_dn, &lsc->bound_dn) ) {
 275                         send_ldap_result( op, rs );
 276                         return rs->sr_err;
 277                 }
 278
 279                 assert( lsc->bound_dn.bv_val );
 280
 281         } else {
 282                 ber_str2bv( "", 0, 1, &lsc->bound_dn );
 283         }
 284
 285         lsc->bound = META_UNBOUND;
 286
 287         /*
 288          * The candidate is activated
 289          */
 290         lsc->candidate = META_CANDIDATE;
 291         return LDAP_SUCCESS;
 292 }
 293
 294 /*
 295  * meta_back_getconn
 296  *
 297  * Prepares the connection structure
 298  *
 299  * FIXME: This function needs to receive some info on the type of operation
 300  * it is invoked by, so that only the correct pool of candidate targets
 301  * is initialized in case no connection was available yet.
 302  *
 303  * At present a flag that says whether the candidate target must be unique
 304  * is passed; eventually an operation agent will be used.
 305  */
 306 struct metaconn *
 307 meta_back_getconn(
 308                 Operation       *op,
 309                 SlapReply       *rs,
 310                 int             op_type,
 311                 struct berval   *ndn,
 312                 int             *candidate )
 313 {
 314         struct metainfo *li = ( struct metainfo * )op->o_bd->be_private;
 315         struct metaconn *lc, lc_curr;
 316         int cached = -1, i = -1, err = LDAP_SUCCESS;
 317         int new_conn = 0;
 318
 319         /* Searches for a metaconn in the avl tree */
 320         lc_curr.conn = op->o_conn;
 321         ldap_pvt_thread_mutex_lock( &li->conn_mutex );
 322         lc = (struct metaconn *)avl_find( li->conntree,
 323                 (caddr_t)&lc_curr, meta_back_conn_cmp );
 324         ldap_pvt_thread_mutex_unlock( &li->conn_mutex );
 325
 326         /* Looks like we didn't get a bind. Open a new session... */
 327         if ( !lc ) {
 328                 lc = metaconn_alloc( li->ntargets );
 329                 lc->conn = op->o_conn;
 330                 new_conn = 1;
 331         }
 332
 333         /*
 334          * looks in cache, if any
 335          */
 336         if ( li->cache.ttl != META_DNCACHE_DISABLED ) {
 337                 cached = i = meta_dncache_get_target( &li->cache, ndn );
 338         }
 339
 340         if ( op_type == META_OP_REQUIRE_SINGLE ) {
 341
 342                 /*
 343                  * tries to get a unique candidate
 344                  * (takes care of default target
 345                  */
 346                 if ( i < 0 ) {
 347                         i = meta_back_select_unique_candidate( li, ndn );
 348                 }
 349
 350                 /*
 351                  * if any is found, inits the connection
 352                  */
 353                 if ( i < 0 ) {
 354                         if ( new_conn ) {
 355                                 metaconn_free( lc );
 356                         }
 357
 358                         rs->sr_err = LDAP_NO_SUCH_OBJECT;
 359                         return NULL;
 360                 }
 361
 362 #ifdef NEW_LOGGING
 363                 LDAP_LOG( BACK_META, INFO,
 364                         "meta_back_getconn: got target %d for ndn=\"%s\" from cache\n",
 365                         i, ndn->bv_val, 0 );
 366 #else /* !NEW_LOGGING */
 367                 Debug( LDAP_DEBUG_CACHE,
 368         "==>meta_back_getconn: got target %d for ndn=\"%s\" from cache\n%s",
 369                                 i, ndn->bv_val, "" );
 370 #endif /* !NEW_LOGGING */
 371
 372                 /*
 373                  * Clear all other candidates
 374                  */
 375                 ( void )meta_clear_unused_candidates( li, lc, i, 0 );
 376
 377                 /*
 378                  * The target is activated; if needed, it is
 379                  * also init'd. In case of error, init_one_conn
 380                  * sends the appropriate result.
 381                  */
 382                 err = init_one_conn( op, rs, li->targets[ i ],
 383                                 &lc->conns[ i ] );
 384                 if ( err != LDAP_SUCCESS ) {
 385
 386                         /*
 387                          * FIXME: in case one target cannot
 388                          * be init'd, should the other ones
 389                          * be tried?
 390                          */
 391                         ( void )meta_clear_one_candidate( &lc->conns[ i ], 1 );
 392                         if ( new_conn ) {
 393                                 metaconn_free( lc );
 394                         }
 395                         return NULL;
 396                 }
 397
 398                 if ( candidate ) {
 399                         *candidate = i;
 400                 }
 401
 402         /*
 403          * require all connections ...
 404          */
 405         } else if (op_type == META_OP_REQUIRE_ALL) {
 406                 for ( i = 0; i < li->ntargets; i++ ) {
 407
 408                         /*
 409                          * The target is activated; if needed, it is
 410                          * also init'd
 411                          */
 412                         int lerr = init_one_conn( op, rs, li->targets[ i ],
 413                                         &lc->conns[ i ] );
 414                         if ( lerr != LDAP_SUCCESS ) {
 415
 416                                 /*
 417                                  * FIXME: in case one target cannot
 418                                  * be init'd, should the other ones
 419                                  * be tried?
 420                                  */
 421                                 ( void )meta_clear_one_candidate( &lc->conns[ i ], 1 );
 422                                 err = lerr;
 423                                 continue;
 424                         }
 425                 }
 426
 427         /*
 428          * if no unique candidate ...
 429          */
 430         } else {
 431                 for ( i = 0; i < li->ntargets; i++ ) {
 432                         if ( i == cached
 433                 || meta_back_is_candidate( &li->targets[ i ]->suffix, ndn ) ) {
 434
 435                                 /*
 436                                  * The target is activated; if needed, it is
 437                                  * also init'd
 438                                  */
 439                                 int lerr = init_one_conn( op, rs,
 440                                                 li->targets[ i ],
 441                                                 &lc->conns[ i ] );
 442                                 if ( lerr != LDAP_SUCCESS ) {
 443
 444                                         /*
 445                                          * FIXME: in case one target cannot
 446                                          * be init'd, should the other ones
 447                                          * be tried?
 448                                          */
 449                                         ( void )meta_clear_one_candidate( &lc->conns[ i ], 1 );
 450                                         err = lerr;
 451                                         continue;
 452                                 }
 453                         }
 454                 }
 455         }
 456
 457         /* clear out init_one_conn non-fatal errors */
 458         rs->sr_err = LDAP_SUCCESS;
 459         rs->sr_text = NULL;
 460
 461         if ( new_conn ) {
 462
 463                 /*
 464                  * Inserts the newly created metaconn in the avl tree
 465                  */
 466                 ldap_pvt_thread_mutex_lock( &li->conn_mutex );
 467                 err = avl_insert( &li->conntree, ( caddr_t )lc,
 468                                 meta_back_conn_cmp, meta_back_conn_dup );
 469
 470 #if PRINT_CONNTREE > 0
 471                 myprint( li->conntree );
 472 #endif /* PRINT_CONNTREE */
 473
 474                 ldap_pvt_thread_mutex_unlock( &li->conn_mutex );
 475
 476 #ifdef NEW_LOGGING
 477                 LDAP_LOG( BACK_META, INFO,
 478                         "meta_back_getconn: conn %ld inserted\n", lc->conn->c_connid, 0, 0);
 479 #else /* !NEW_LOGGING */
 480                 Debug( LDAP_DEBUG_TRACE,
 481                         "=>meta_back_getconn: conn %ld inserted\n%s%s",
 482                         lc->conn->c_connid, "", "" );
 483 #endif /* !NEW_LOGGING */
 484
 485                 /*
 486                  * Err could be -1 in case a duplicate metaconn is inserted
 487                  */
 488                 if ( err != 0 ) {
 489                         rs->sr_err = LDAP_OTHER;
 490                         rs->sr_text = "Internal server error";
 491                         metaconn_free( lc );
 492                         return NULL;
 493                 }
 494         } else {
 495 #ifdef NEW_LOGGING
 496                 LDAP_LOG( BACK_META, INFO,
 497                         "meta_back_getconn: conn %ld fetched\n", lc->conn->c_connid, 0, 0 );
 498 #else /* !NEW_LOGGING */
 499                 Debug( LDAP_DEBUG_TRACE,
 500                         "=>meta_back_getconn: conn %ld fetched\n%s%s",
 501                         lc->conn->c_connid, "", "" );
 502 #endif /* !NEW_LOGGING */
 503         }
 504
 505         return lc;
 506 }
 507