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

   1 /*
   2  * Copyright 1998-2001 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         int i;
 174
 175         assert( ntargets > 0 );
 176
 177         lc = ch_calloc( sizeof( struct metaconn ), 1 );
 178         if ( lc == NULL ) {
 179                 return NULL;
 180         }
 181
 182         /*
 183          * make it a null-terminated array ...
 184          */
 185         lc->conns = ch_calloc( sizeof( struct metasingleconn * ), ntargets+1 );
 186         if ( lc->conns == NULL ) {
 187                 free( lc );
 188                 return NULL;
 189         }
 190
 191         for ( i = 0; i < ntargets; i++ ) {
 192                 lc->conns[ i ] =
 193                         ch_calloc( sizeof( struct metasingleconn ), 1 );
 194                 if ( lc->conns[ i ] == NULL ) {
 195                         charray_free( ( char ** )lc->conns );
 196                         free( lc->conns );
 197                         free( lc );
 198                         return NULL;
 199                 }
 200         }
 201
 202         lc->bound_target = -1;
 203
 204         return lc;
 205 }
 206
 207 /*
 208  * metaconn_free
 209  *
 210  * clears a metaconn
 211  */
 212 static void
 213 metaconn_free(
 214                 struct metaconn *lc
 215 )
 216 {
 217         if ( !lc ) {
 218                 return;
 219         }
 220
 221         if ( lc->conns ) {
 222                 int i;
 223
 224                 for ( i = 0; lc->conns[ i ] != NULL; ++i ) {
 225                         free( lc->conns[ i ] );
 226                 }
 227                 charray_free( ( char ** )lc->conns );
 228         }
 229
 230         free( lc );
 231 }
 232
 233 /*
 234  * init_one_conn
 235  *
 236  * Initializes one connection
 237  */
 238 static int
 239 init_one_conn(
 240                 Connection *conn,
 241                 Operation *op,
 242                 struct metatarget *lt,
 243                 int vers,
 244                 struct metasingleconn *lsc
 245                 )
 246 {
 247         int err;
 248
 249         /*
 250          * Already init'ed
 251          */
 252         if ( lsc->ld != NULL ) {
 253                 return LDAP_SUCCESS;
 254         }
 255
 256         /*
 257          * Attempts to initialize the connection to the target ds
 258          */
 259         err = ldap_initialize( &lsc->ld, lt->uri );
 260
 261         /*
 262          * In case of failure, the error is mapped back from client
 263          * to server error code
 264          */
 265         if ( err != LDAP_SUCCESS ) {
 266                 return ldap_back_map_result( err );
 267         }
 268
 269         /*
 270          * Set LDAP version. This will always succeed: If the client
 271          * bound with a particular version, then so can we.
 272          */
 273         ldap_set_option( lsc->ld, LDAP_OPT_PROTOCOL_VERSION, &vers );
 274
 275         /*
 276          * Sets a cookie for the rewrite session
 277          */
 278         ( void )rewrite_session_init( lt->rwinfo, conn );
 279
 280         /*
 281          * If the connection dn is not null, an attempt to rewrite it is made
 282          */
 283         if ( conn->c_cdn != NULL && conn->c_cdn[ 0 ] != '\0' ) {
 284                 /*
 285                  * Rewrite the bind dn if needed
 286                  */
 287                 lsc->bound_dn = NULL;
 288                 switch ( rewrite_session( lt->rwinfo, "bindDn",
 289                                         conn->c_cdn, conn,
 290                                         &lsc->bound_dn ) ) {
 291                 case REWRITE_REGEXEC_OK:
 292                         if ( lsc->bound_dn == NULL ) {
 293                                 lsc->bound_dn = ch_strdup( conn->c_cdn );
 294                         }
 295 #ifdef NEW_LOGGING
 296                         LDAP_LOG(( "backend", LDAP_LEVEL_DETAIL1,
 297                                         "[rw] bindDn: \"%s\" -> \"%s\"\n",
 298                                         conn->c_cdn, lsc->bound_dn ));
 299 #else /* !NEW_LOGGING */
 300                         Debug( LDAP_DEBUG_ARGS,
 301                                         "rw> bindDn: \"%s\" -> \"%s\"\n%s",
 302                                         conn->c_cdn, lsc->bound_dn, "" );
 303 #endif /* !NEW_LOGGING */
 304                         break;
 305
 306                 case REWRITE_REGEXEC_UNWILLING:
 307                         send_ldap_result( conn, op,
 308                                         LDAP_UNWILLING_TO_PERFORM,
 309                                         NULL, "Unwilling to perform",
 310                                         NULL, NULL );
 311                         /* continues to the next case */
 312
 313                 case REWRITE_REGEXEC_ERR:
 314                         return LDAP_OPERATIONS_ERROR;
 315                 }
 316         } else {
 317                 lsc->bound_dn = NULL;
 318         }
 319
 320         lsc->bound = META_UNBOUND;
 321
 322         /*
 323          * The candidate is activated
 324          */
 325         lsc->candidate = META_CANDIDATE;
 326         return LDAP_SUCCESS;
 327 }
 328
 329 /*
 330  * meta_back_getconn
 331  *
 332  * Prepares the connection structure
 333  *
 334  * FIXME: This function needs to receive some info on the type of operation
 335  * it is invoked by, so that only the correct pool of candidate targets
 336  * is initialized in case no connection was available yet.
 337  *
 338  * At present a flag that says whether the candidate target must be unique
 339  * is passed; eventually an operation agent will be used.
 340  */
 341 struct metaconn *
 342 meta_back_getconn(
 343                 struct metainfo *li,
 344                 Connection *conn,
 345                 Operation *op,
 346                 int op_type,
 347                 const char *ndn,
 348                 int *candidate
 349                 )
 350 {
 351         struct metaconn *lc, lc_curr;
 352         int vers, cached = -1, i = -1, err = LDAP_SUCCESS;
 353         int new_conn = 0;
 354
 355         /* Searches for a metaconn in the avl tree */
 356         lc_curr.conn = conn;
 357         ldap_pvt_thread_mutex_lock( &li->conn_mutex );
 358         lc = (struct metaconn *)avl_find( li->conntree,
 359                 (caddr_t)&lc_curr, meta_back_conn_cmp );
 360         ldap_pvt_thread_mutex_unlock( &li->conn_mutex );
 361
 362         /* Looks like we didn't get a bind. Open a new session... */
 363         if ( !lc ) {
 364                 lc = metaconn_alloc( li->ntargets );
 365                 lc->conn = conn;
 366                 new_conn = 1;
 367         }
 368
 369         vers = conn->c_protocol;
 370
 371         /*
 372          * looks in cache, if any
 373          */
 374         if ( li->cache.ttl != META_DNCACHE_DISABLED ) {
 375                 cached = i = meta_dncache_get_target( &li->cache, ndn );
 376         }
 377
 378         if ( op_type == META_OP_REQUIRE_SINGLE ) {
 379
 380                 /*
 381                  * tries to get a unique candidate
 382                  * (takes care of default target
 383                  */
 384                 if ( i < 0 ) {
 385                         i = meta_back_select_unique_candidate( li, ndn );
 386                 }
 387
 388                 /*
 389                  * if any is found, inits the connection
 390                  */
 391                 if ( i < 0 ) {
 392                         if ( new_conn ) {
 393                                 metaconn_free( lc );
 394                         }
 395
 396                         send_ldap_result( conn, op, LDAP_NO_SUCH_OBJECT,
 397                                 NULL, "", NULL, NULL );
 398
 399                         return NULL;
 400                 }
 401
 402 #ifdef NEW_LOGGING
 403                 LDAP_LOG(( "backend", LDAP_LEVEL_INFO,
 404                                 "meta_back_getconn: got target %d"
 405                                 " for ndn=\"%s\" from cache\n", i, ndn ));
 406 #else /* !NEW_LOGGING */
 407                 Debug( LDAP_DEBUG_CACHE,
 408         "==>meta_back_getconn: got target %d for ndn=\"%s\" from cache\n%s",
 409                                 i, ndn, "" );
 410 #endif /* !NEW_LOGGING */
 411
 412                 /*
 413                  * Clear all other candidates
 414                  */
 415                 ( void )meta_clear_unused_candidates( li, lc, i, 0 );
 416
 417                 /*
 418                  * The target is activated; if needed, it is
 419                  * also init'd
 420                  */
 421                 err = init_one_conn( conn, op, li->targets[ i ],
 422                                 vers, lc->conns[ i ] );
 423                 if ( err != LDAP_SUCCESS ) {
 424
 425                         /*
 426                          * FIXME: in case one target cannot
 427                          * be init'd, should the other ones
 428                          * be tried?
 429                          */
 430                         ( void )meta_clear_one_candidate( lc->conns[ i ], 1 );
 431                         if ( new_conn ) {
 432                                 metaconn_free( lc );
 433                         }
 434
 435                         send_ldap_result( conn, op, LDAP_OPERATIONS_ERROR,                                      NULL, "internal server error", NULL, NULL );
 436
 437                         return NULL;
 438                 }
 439
 440                 if ( candidate ) {
 441                         *candidate = i;
 442                 }
 443
 444         /*
 445          * if no unique candidate ...
 446          */
 447         } else {
 448                 int ndnlen = strlen( ndn );
 449                 for ( i = 0; i < li->ntargets; i++ ) {
 450                         if ( i == cached
 451                 || meta_back_is_candidate( li->targets[ i ]->suffix,
 452                                         ndn, ndnlen ) ) {
 453
 454                                 /*
 455                                  * The target is activated; if needed, it is
 456                                  * also init'd
 457                                  */
 458                                 int lerr = init_one_conn( conn, op,
 459                                                 li->targets[ i ],
 460                                                 vers, lc->conns[ i ] );
 461                                 if ( lerr != LDAP_SUCCESS ) {
 462
 463                                         /*
 464                                          * FIXME: in case one target cannot
 465                                          * be init'd, should the other ones
 466                                          * be tried?
 467                                          */
 468                                         ( void )meta_clear_one_candidate( lc->conns[ i ], 1 );
 469                                         err = lerr;
 470                                         continue;
 471                                 }
 472                         }
 473                 }
 474         }
 475
 476         if ( new_conn ) {
 477
 478                 /*
 479                  * Inserts the newly created metaconn in the avl tree
 480                  */
 481                 ldap_pvt_thread_mutex_lock( &li->conn_mutex );
 482                 err = avl_insert( &li->conntree, ( caddr_t )lc,
 483                                 meta_back_conn_cmp, meta_back_conn_dup );
 484
 485 #if PRINT_CONNTREE > 0
 486                 myprint( li->conntree );
 487 #endif /* PRINT_CONNTREE */
 488
 489                 ldap_pvt_thread_mutex_unlock( &li->conn_mutex );
 490
 491 #ifdef NEW_LOGGING
 492                 LDAP_LOG(( "backend", LDAP_LEVEL_INFO,
 493                                 "meta_back_getconn: conn %ld inserted\n",
 494                                 lc->conn->c_connid ));
 495 #else /* !NEW_LOGGING */
 496                 Debug( LDAP_DEBUG_TRACE,
 497                         "=>meta_back_getconn: conn %ld inserted\n%s%s",
 498                         lc->conn->c_connid, "", "" );
 499 #endif /* !NEW_LOGGING */
 500
 501                 /*
 502                  * Err could be -1 in case a duplicate metaconn is inserted
 503                  */
 504                 if ( err != 0 ) {
 505                         send_ldap_result( conn, op, LDAP_OPERATIONS_ERROR,
 506                         NULL, "internal server error", NULL, NULL );
 507                         metaconn_free( lc );
 508                         return NULL;
 509                 }
 510         } else {
 511 #ifdef NEW_LOGGING
 512                 LDAP_LOG(( "backend", LDAP_LEVEL_INFO,
 513                                 "meta_back_getconn: conn %ld fetched\n",
 514                                 lc->conn->c_connid ));
 515 #else /* !NEW_LOGGING */
 516                 Debug( LDAP_DEBUG_TRACE,
 517                         "=>meta_back_getconn: conn %ld fetched\n%s%s",
 518                         lc->conn->c_connid, "", "" );
 519 #endif /* !NEW_LOGGING */
 520         }
 521
 522         return lc;
 523 }
 524