git.sur5r.net Git - openldap/blob - servers/slapd/back-bdb/index.c

   1 /* index.c - routines for dealing with attribute indexes */
   2 /* $OpenLDAP$ */
   3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
   4  *
   5  * Copyright 2000-2005 The OpenLDAP Foundation.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted only as authorized by the OpenLDAP
  10  * Public License.
  11  *
  12  * A copy of this license is available in the file LICENSE in the
  13  * top-level directory of the distribution or, alternatively, at
  14  * <http://www.OpenLDAP.org/license.html>.
  15  */
  16
  17 #include "portable.h"
  18
  19 #include <stdio.h>
  20
  21 #include <ac/string.h>
  22 #include <ac/socket.h>
  23
  24 #include "slap.h"
  25 #include "back-bdb.h"
  26 #include "lutil_hash.h"
  27
  28 static char presence_keyval[LUTIL_HASH_BYTES] = {0,0,0,1};
  29 static struct berval presence_key = {LUTIL_HASH_BYTES, presence_keyval};
  30
  31 static AttrInfo *index_mask(
  32         Backend *be,
  33         AttributeDescription *desc,
  34         struct berval *atname )
  35 {
  36         AttributeType *at;
  37         AttrInfo *ai = bdb_attr_mask( be->be_private, desc );
  38
  39         if( ai ) {
  40                 *atname = desc->ad_cname;
  41                 return ai;
  42         }
  43
  44         /* If there is a tagging option, did we ever index the base
  45          * type? If so, check for mask, otherwise it's not there.
  46          */
  47         if( slap_ad_is_tagged( desc ) && desc != desc->ad_type->sat_ad ) {
  48                 /* has tagging option */
  49                 ai = bdb_attr_mask( be->be_private, desc->ad_type->sat_ad );
  50
  51                 if ( ai && ( ai->ai_indexmask ^ SLAP_INDEX_NOTAGS ) ) {
  52                         *atname = desc->ad_type->sat_cname;
  53                         return ai;
  54                 }
  55         }
  56
  57         /* see if supertype defined mask for its subtypes */
  58         for( at = desc->ad_type; at != NULL ; at = at->sat_sup ) {
  59                 /* If no AD, we've never indexed this type */
  60                 if ( !at->sat_ad ) continue;
  61
  62                 ai = bdb_attr_mask( be->be_private, at->sat_ad );
  63
  64                 if ( ai && ( ai->ai_indexmask ^ SLAP_INDEX_NOSUBTYPES ) ) {
  65                         *atname = at->sat_cname;
  66                         return ai;
  67                 }
  68         }
  69
  70         return 0;
  71 }
  72
  73 int bdb_index_is_indexed(
  74         Backend *be,
  75         AttributeDescription *desc )
  76 {
  77         AttrInfo *ai;
  78         struct berval prefix;
  79
  80         ai = index_mask( be, desc, &prefix );
  81
  82         if( !ai )
  83                 return LDAP_INAPPROPRIATE_MATCHING;
  84
  85         return LDAP_SUCCESS;
  86 }
  87
  88 /* This function is only called when evaluating search filters.
  89  */
  90 int bdb_index_param(
  91         Backend *be,
  92         AttributeDescription *desc,
  93         int ftype,
  94         DB **dbp,
  95         slap_mask_t *maskp,
  96         struct berval *prefixp )
  97 {
  98         AttrInfo *ai;
  99         int rc;
 100         slap_mask_t mask;
 101         DB *db;
 102
 103         ai = index_mask( be, desc, prefixp );
 104
 105         if( !ai ) {
 106                 return LDAP_INAPPROPRIATE_MATCHING;
 107         }
 108         mask = ai->ai_indexmask;
 109
 110         rc = bdb_db_cache( be, prefixp->bv_val, &db );
 111
 112         if( rc != LDAP_SUCCESS ) {
 113                 return rc;
 114         }
 115
 116         switch( ftype ) {
 117         case LDAP_FILTER_PRESENT:
 118                 if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
 119                         *prefixp = presence_key;
 120                         goto done;
 121                 }
 122                 break;
 123
 124         case LDAP_FILTER_APPROX:
 125                 if ( desc->ad_type->sat_approx ) {
 126                         if( IS_SLAP_INDEX( mask, SLAP_INDEX_APPROX ) ) {
 127                                 goto done;
 128                         }
 129                         break;
 130                 }
 131
 132                 /* Use EQUALITY rule and index for approximate match */
 133                 /* fall thru */
 134
 135         case LDAP_FILTER_EQUALITY:
 136                 if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
 137                         goto done;
 138                 }
 139                 break;
 140
 141         case LDAP_FILTER_SUBSTRINGS:
 142                 if( IS_SLAP_INDEX( mask, SLAP_INDEX_SUBSTR ) ) {
 143                         goto done;
 144                 }
 145                 break;
 146
 147         default:
 148                 return LDAP_OTHER;
 149         }
 150
 151         return LDAP_INAPPROPRIATE_MATCHING;
 152
 153 done:
 154         *dbp = db;
 155         *maskp = mask;
 156         return LDAP_SUCCESS;
 157 }
 158
 159 static int indexer(
 160         Operation *op,
 161         DB_TXN *txn,
 162         AttributeDescription *ad,
 163         struct berval *atname,
 164         BerVarray vals,
 165         ID id,
 166         int opid,
 167         slap_mask_t mask )
 168 {
 169         int rc, i;
 170         DB *db;
 171         struct berval *keys;
 172
 173         assert( mask );
 174
 175         rc = bdb_db_cache( op->o_bd, atname->bv_val, &db );
 176
 177         if ( rc != LDAP_SUCCESS ) {
 178                 Debug( LDAP_DEBUG_ANY,
 179                         "bdb_index_read: Could not open DB %s\n",
 180                         atname->bv_val, 0, 0 );
 181                 return LDAP_OTHER;
 182         }
 183
 184         if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
 185                 rc = bdb_key_change( op->o_bd, db, txn, &presence_key, id, opid );
 186                 if( rc ) {
 187                         goto done;
 188                 }
 189         }
 190
 191         if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
 192                 rc = ad->ad_type->sat_equality->smr_indexer(
 193                         LDAP_FILTER_EQUALITY,
 194                         mask,
 195                         ad->ad_type->sat_syntax,
 196                         ad->ad_type->sat_equality,
 197                         atname, vals, &keys, op->o_tmpmemctx );
 198
 199                 if( rc == LDAP_SUCCESS && keys != NULL ) {
 200                         for( i=0; keys[i].bv_val != NULL; i++ ) {
 201                                 rc = bdb_key_change( op->o_bd, db, txn, &keys[i], id, opid );
 202                                 if( rc ) {
 203                                         ber_bvarray_free_x( keys, op->o_tmpmemctx );
 204                                         goto done;
 205                                 }
 206                         }
 207                         ber_bvarray_free_x( keys, op->o_tmpmemctx );
 208                 }
 209                 rc = LDAP_SUCCESS;
 210         }
 211
 212         if( IS_SLAP_INDEX( mask, SLAP_INDEX_APPROX ) ) {
 213                 rc = ad->ad_type->sat_approx->smr_indexer(
 214                         LDAP_FILTER_APPROX,
 215                         mask,
 216                         ad->ad_type->sat_syntax,
 217                         ad->ad_type->sat_approx,
 218                         atname, vals, &keys, op->o_tmpmemctx );
 219
 220                 if( rc == LDAP_SUCCESS && keys != NULL ) {
 221                         for( i=0; keys[i].bv_val != NULL; i++ ) {
 222                                 rc = bdb_key_change( op->o_bd, db, txn, &keys[i], id, opid );
 223                                 if( rc ) {
 224                                         ber_bvarray_free_x( keys, op->o_tmpmemctx );
 225                                         goto done;
 226                                 }
 227                         }
 228                         ber_bvarray_free_x( keys, op->o_tmpmemctx );
 229                 }
 230
 231                 rc = LDAP_SUCCESS;
 232         }
 233
 234         if( IS_SLAP_INDEX( mask, SLAP_INDEX_SUBSTR ) ) {
 235                 rc = ad->ad_type->sat_substr->smr_indexer(
 236                         LDAP_FILTER_SUBSTRINGS,
 237                         mask,
 238                         ad->ad_type->sat_syntax,
 239                         ad->ad_type->sat_substr,
 240                         atname, vals, &keys, op->o_tmpmemctx );
 241
 242                 if( rc == LDAP_SUCCESS && keys != NULL ) {
 243                         for( i=0; keys[i].bv_val != NULL; i++ ) {
 244                                 rc = bdb_key_change( op->o_bd, db, txn, &keys[i], id, opid );
 245                                 if( rc ) {
 246                                         ber_bvarray_free_x( keys, op->o_tmpmemctx );
 247                                         goto done;
 248                                 }
 249                         }
 250                         ber_bvarray_free_x( keys, op->o_tmpmemctx );
 251                 }
 252
 253                 rc = LDAP_SUCCESS;
 254         }
 255
 256 done:
 257         switch( rc ) {
 258         /* The callers all know how to deal with these results */
 259         case 0:
 260         case DB_LOCK_DEADLOCK:
 261         case DB_LOCK_NOTGRANTED:
 262                 break;
 263         /* Anything else is bad news */
 264         default:
 265                 rc = LDAP_OTHER;
 266         }
 267         return rc;
 268 }
 269
 270 static int index_at_values(
 271         Operation *op,
 272         DB_TXN *txn,
 273         AttributeDescription *ad,
 274         AttributeType *type,
 275         struct berval *tags,
 276         BerVarray vals,
 277         ID id,
 278         int opid )
 279 {
 280         int rc;
 281         slap_mask_t mask = 0;
 282         int ixop = opid;
 283         AttrInfo *ai = NULL;
 284
 285         if ( opid == BDB_INDEX_UPDATE_OP )
 286                 ixop = SLAP_INDEX_ADD_OP;
 287
 288         if( type->sat_sup ) {
 289                 /* recurse */
 290                 rc = index_at_values( op, txn, NULL,
 291                         type->sat_sup, tags,
 292                         vals, id, opid );
 293
 294                 if( rc ) return rc;
 295         }
 296
 297         /* If this type has no AD, we've never used it before */
 298         if( type->sat_ad ) {
 299                 ai = bdb_attr_mask( op->o_bd->be_private, type->sat_ad );
 300                 if ( ai ) {
 301 #ifdef LDAP_COMP_MATCH
 302                         /* component indexing */
 303                         if ( ai->ai_cr ) {
 304                                 ComponentReference *cr;
 305                                 for( cr = ai->ai_cr ; cr ; cr = cr->cr_next ) {
 306                                         rc = indexer( op, txn, cr->cr_ad, &type->sat_cname,
 307                                                 cr->cr_nvals, id, ixop,
 308                                                 cr->cr_indexmask );
 309                                 }
 310                         }
 311 #endif
 312                         ad = type->sat_ad;
 313                         /* If we're updating the index, just set the new bits that aren't
 314                          * already in the old mask.
 315                          */
 316                         if ( opid == BDB_INDEX_UPDATE_OP )
 317                                 mask = ai->ai_newmask & ~ai->ai_indexmask;
 318                         else
 319                         /* For regular updates, if there is a newmask use it. Otherwise
 320                          * just use the old mask.
 321                          */
 322                                 mask = ai->ai_newmask ? ai->ai_newmask : ai->ai_indexmask;
 323                         if( mask ) {
 324                                 rc = indexer( op, txn, ad, &type->sat_cname,
 325                                         vals, id, ixop, mask );
 326
 327                                 if( rc ) return rc;
 328                         }
 329                 }
 330         }
 331
 332         if( tags->bv_len ) {
 333                 AttributeDescription *desc;
 334
 335                 desc = ad_find_tags( type, tags );
 336                 if( desc ) {
 337                         ai = bdb_attr_mask( op->o_bd->be_private, desc );
 338
 339                         if( ai ) {
 340                                 if ( opid == BDB_INDEX_UPDATE_OP )
 341                                         mask = ai->ai_newmask & ~ai->ai_indexmask;
 342                                 else
 343                                         mask = ai->ai_newmask ? ai->ai_newmask : ai->ai_indexmask;
 344                                 if ( mask ) {
 345                                         rc = indexer( op, txn, desc, &desc->ad_cname,
 346                                                 vals, id, ixop, mask );
 347
 348                                         if( rc ) {
 349                                                 return rc;
 350                                         }
 351                                 }
 352                         }
 353                 }
 354         }
 355
 356         return LDAP_SUCCESS;
 357 }
 358
 359 int bdb_index_values(
 360         Operation *op,
 361         DB_TXN *txn,
 362         AttributeDescription *desc,
 363         BerVarray vals,
 364         ID id,
 365         int opid )
 366 {
 367         int rc;
 368
 369         /* Never index ID 0 */
 370         if ( id == 0 )
 371                 return 0;
 372
 373         rc = index_at_values( op, txn, desc,
 374                 desc->ad_type, &desc->ad_tags,
 375                 vals, id, opid );
 376
 377         return rc;
 378 }
 379
 380 int
 381 bdb_index_entry(
 382         Operation *op,
 383         DB_TXN *txn,
 384         int opid,
 385         Entry   *e )
 386 {
 387         int rc;
 388         Attribute *ap = e->e_attrs;
 389 #ifdef LDAP_COMP_MATCH
 390         ComponentReference *cr_list = NULL;
 391         ComponentReference *cr = NULL, *dupped_cr = NULL;
 392         void* decoded_comp, *extracted_comp;
 393         ComponentSyntaxInfo* csi_attr;
 394         Syntax* syn;
 395         AttributeType* at;
 396         int i, num_attr;
 397         void* mem_op;
 398         struct berval value = {0};
 399 #endif
 400
 401         Debug( LDAP_DEBUG_TRACE, "=> index_entry_%s( %ld, \"%s\" )\n",
 402                 opid == SLAP_INDEX_DELETE_OP ? "del" : "add",
 403                 (long) e->e_id, e->e_dn );
 404
 405         /* add each attribute to the indexes */
 406         for ( ; ap != NULL; ap = ap->a_next ) {
 407 #ifdef LDAP_COMP_MATCH
 408                 AttrInfo *ai;
 409                 /* see if attribute has components to be indexed */
 410                 ai = bdb_attr_mask( op->o_bd->be_private, ap->a_desc->ad_type->sat_ad );
 411                 if ( ai ) cr_list = ai->ai_cr;
 412                 else cr_list = NULL;
 413                 if ( attr_converter && cr_list ) {
 414                         syn = ap->a_desc->ad_type->sat_syntax;
 415                         ap->a_comp_data = op->o_tmpalloc( sizeof( ComponentData ), op->o_tmpmemctx );
 416                         /* Memory chunk(nibble) pre-allocation for decoders */
 417                         mem_op = nibble_mem_allocator ( 1024*16, 1024*4 );
 418                         ap->a_comp_data->cd_mem_op = mem_op;
 419                         for( cr = cr_list ; cr ; cr = cr->cr_next ) {
 420                                 /* count how many values in an attribute */
 421                                 for( num_attr=0; ap->a_vals[num_attr].bv_val != NULL; num_attr++ );
 422                                 num_attr++;
 423                                 cr->cr_nvals = (BerVarray)op->o_tmpalloc( sizeof( struct berval )*num_attr, op->o_tmpmemctx );
 424                                 for( i=0; ap->a_vals[i].bv_val != NULL; i++ ) {
 425                                         /* decoding attribute value */
 426                                         decoded_comp = attr_converter ( ap, syn, &ap->a_vals[i] );
 427                                         if ( !decoded_comp )
 428                                                 return LDAP_DECODING_ERROR;
 429                                         /* extracting the referenced component */
 430                                         dupped_cr = dup_comp_ref( op, cr );
 431                                         csi_attr = ((ComponentSyntaxInfo*)decoded_comp)->csi_comp_desc->cd_extract_i( mem_op, dupped_cr, decoded_comp );
 432                                         if ( !csi_attr )
 433                                                 return LDAP_DECODING_ERROR;
 434                                         cr->cr_asn_type_id = csi_attr->csi_comp_desc->cd_type_id;
 435                                         cr->cr_ad = (AttributeDescription*)get_component_description ( cr->cr_asn_type_id );
 436                                         if ( !cr->cr_ad )
 437                                                 return LDAP_INVALID_SYNTAX;
 438                                         at = cr->cr_ad->ad_type;
 439                                         /* encoding the value of component in GSER */
 440                                         rc = component_encoder( mem_op, csi_attr, &value );
 441                                         if ( rc != LDAP_SUCCESS )
 442                                                 return LDAP_ENCODING_ERROR;
 443                                         /* Normalize the encoded component values */
 444                                         if ( at->sat_equality && at->sat_equality->smr_normalize ) {
 445                                                 rc = at->sat_equality->smr_normalize (
 446                                                         SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
 447                                                         at->sat_syntax, at->sat_equality,
 448                                                         &value, &cr->cr_nvals[i], op->o_tmpmemctx );
 449                                         } else {
 450                                                 cr->cr_nvals[i] = value;
 451                                         }
 452                                 }
 453                                 /* The end of BerVarray */
 454                                 cr->cr_nvals[num_attr-1].bv_val = NULL;
 455                                 cr->cr_nvals[num_attr-1].bv_len = 0;
 456                         }
 457                         op->o_tmpfree( ap->a_comp_data, op->o_tmpmemctx );
 458                         nibble_mem_free ( mem_op );
 459                         ap->a_comp_data = NULL;
 460                 }
 461 #endif
 462                 rc = bdb_index_values( op, txn, ap->a_desc,
 463                         ap->a_nvals, e->e_id, opid );
 464
 465                 if( rc != LDAP_SUCCESS ) {
 466                         Debug( LDAP_DEBUG_TRACE,
 467                                 "<= index_entry_%s( %ld, \"%s\" ) failure\n",
 468                                 opid == SLAP_INDEX_ADD_OP ? "add" : "del",
 469                                 (long) e->e_id, e->e_dn );
 470                         return rc;
 471                 }
 472         }
 473
 474         Debug( LDAP_DEBUG_TRACE, "<= index_entry_%s( %ld, \"%s\" ) success\n",
 475                 opid == SLAP_INDEX_DELETE_OP ? "del" : "add",
 476                 (long) e->e_id, e->e_dn );
 477
 478         return LDAP_SUCCESS;
 479 }