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

   1 /* $OpenLDAP$ */
   2 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   3  *
   4  * Copyright 1999-2004 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 "slap.h"
  28 #include "../back-ldap/back-ldap.h"
  29 #include "back-meta.h"
  30
  31 /*
  32  * The meta-directory has one suffix, called <suffix>.
  33  * It handles a pool of target servers, each with a branch suffix
  34  * of the form <branch X>,<suffix>
  35  *
  36  * When the meta-directory receives a request with a dn that belongs
  37  * to a branch, the corresponding target is invoked. When the dn
  38  * does not belong to a specific branch, all the targets that
  39  * are compatible with the dn are selected as candidates, and
  40  * the request is spawned to all the candidate targets
  41  *
  42  * A request is characterized by a dn. The following cases are handled:
  43  *      - the dn is the suffix: <dn> == <suffix>,
  44  *              all the targets are candidates (search ...)
  45  *      - the dn is a branch suffix: <dn> == <branch X>,<suffix>, or
  46  *      - the dn is a subtree of a branch suffix:
  47  *              <dn> == <rdn>,<branch X>,<suffix>,
  48  *              the target is the only candidate.
  49  *
  50  * A possible extension will include the handling of multiple suffixes
  51  */
  52
  53 /*
  54  * returns 1 if suffix is candidate for dn, otherwise 0
  55  *
  56  * Note: this function should never be called if dn is the <suffix>.
  57  */
  58 int
  59 meta_back_is_candidate(
  60                 struct berval   *nsuffix,
  61                 struct berval   *ndn
  62 )
  63 {
  64         if ( dnIsSuffix( nsuffix, ndn ) || dnIsSuffix( ndn, nsuffix ) ) {
  65                 /*
  66                  * suffix longer than dn
  67                  */
  68                 return META_CANDIDATE;
  69         }
  70
  71         return META_NOT_CANDIDATE;
  72 }
  73
  74 /*
  75  * meta_back_count_candidates
  76  *
  77  * returns a count of the possible candidate targets
  78  * Note: dn MUST be normalized
  79  */
  80
  81 int
  82 meta_back_count_candidates(
  83                 struct metainfo         *li,
  84                 struct berval           *ndn
  85 )
  86 {
  87         int i, cnt = 0;
  88
  89         /*
  90          * I know assertions should not check run-time values;
  91          * at present I didn't find a place for such checks
  92          * after config.c
  93          */
  94         assert( li->targets != NULL );
  95         assert( li->ntargets != 0 );
  96
  97         for ( i = 0; i < li->ntargets; ++i ) {
  98                 if ( meta_back_is_candidate( &li->targets[ i ]->suffix, ndn ) ) {
  99                         ++cnt;
 100                 }
 101         }
 102
 103         return cnt;
 104 }
 105
 106 /*
 107  * meta_back_is_candidate_unique
 108  *
 109  * checks whether a candidate is unique
 110  * Note: dn MUST be normalized
 111  */
 112 int
 113 meta_back_is_candidate_unique(
 114                 struct metainfo         *li,
 115                 struct berval           *ndn
 116 )
 117 {
 118         return ( meta_back_count_candidates( li, ndn ) == 1 );
 119 }
 120
 121 /*
 122  * meta_back_select_unique_candidate
 123  *
 124  * returns the index of the candidate in case it is unique, otherwise -1
 125  * Note: dn MUST be normalized.
 126  * Note: if defined, the default candidate is returned in case of no match.
 127  */
 128 int
 129 meta_back_select_unique_candidate(
 130                 struct metainfo         *li,
 131                 struct berval           *ndn
 132 )
 133 {
 134         int i;
 135
 136         switch ( meta_back_count_candidates( li, ndn ) ) {
 137         case 1:
 138                 break;
 139         case 0:
 140         default:
 141                 return ( li->defaulttarget == META_DEFAULT_TARGET_NONE
 142                                 ? -1 : li->defaulttarget );
 143         }
 144
 145         for ( i = 0; i < li->ntargets; ++i ) {
 146                 if ( meta_back_is_candidate( &li->targets[ i ]->suffix, ndn ) ) {
 147                         return i;
 148                 }
 149         }
 150
 151         return -1;
 152 }
 153
 154 /*
 155  * meta_clear_unused_candidates
 156  *
 157  * clears all candidates except candidate
 158  */
 159 int
 160 meta_clear_unused_candidates(
 161                 struct metainfo         *li,
 162                 struct metaconn         *lc,
 163                 int                     candidate,
 164                 int                     reallyclean
 165 )
 166 {
 167         int i;
 168
 169         for ( i = 0; i < li->ntargets; ++i ) {
 170                 if ( i == candidate ) {
 171                         continue;
 172                 }
 173                 meta_clear_one_candidate( &lc->conns[ i ], reallyclean );
 174         }
 175
 176         return 0;
 177 }
 178
 179 /*
 180  * meta_clear_one_candidate
 181  *
 182  * clears the selected candidate
 183  */
 184 int
 185 meta_clear_one_candidate(
 186                 struct metasingleconn   *lsc,
 187                 int                     reallyclean
 188 )
 189 {
 190         lsc->candidate = META_NOT_CANDIDATE;
 191
 192         if ( !reallyclean ) {
 193                 return 0;
 194         }
 195
 196         if ( lsc->ld ) {
 197                 ldap_unbind( lsc->ld );
 198                 lsc->ld = NULL;
 199         }
 200
 201         if ( lsc->bound_dn.bv_val != NULL ) {
 202                 ber_memfree( lsc->bound_dn.bv_val );
 203                 lsc->bound_dn.bv_val = NULL;
 204                 lsc->bound_dn.bv_len = 0;
 205         }
 206
 207         return 0;
 208 }
 209