1 /* index.c - routines for dealing with attribute indexes */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2005 The OpenLDAP Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted only as authorized by the OpenLDAP
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>.
21 #include <ac/string.h>
22 #include <ac/socket.h>
26 #include "lutil_hash.h"
28 static char presence_keyval[LUTIL_HASH_BYTES] = {0,0,0,1};
29 static struct berval presence_key = {LUTIL_HASH_BYTES, presence_keyval};
31 static AttrInfo *index_mask(
33 AttributeDescription *desc,
34 struct berval *atname )
37 AttrInfo *ai = bdb_attr_mask( be->be_private, desc );
40 *atname = desc->ad_cname;
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.
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 );
51 if ( ai && ( ai->ai_indexmask ^ SLAP_INDEX_NOTAGS ) ) {
52 *atname = desc->ad_type->sat_cname;
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;
62 ai = bdb_attr_mask( be->be_private, at->sat_ad );
64 if ( ai && ( ai->ai_indexmask ^ SLAP_INDEX_NOSUBTYPES ) ) {
65 *atname = at->sat_cname;
73 int bdb_index_is_indexed(
75 AttributeDescription *desc )
80 ai = index_mask( be, desc, &prefix );
83 return LDAP_INAPPROPRIATE_MATCHING;
88 /* This function is only called when evaluating search filters.
92 AttributeDescription *desc,
96 struct berval *prefixp )
103 ai = index_mask( be, desc, prefixp );
106 return LDAP_INAPPROPRIATE_MATCHING;
108 mask = ai->ai_indexmask;
110 rc = bdb_db_cache( be, prefixp->bv_val, &db );
112 if( rc != LDAP_SUCCESS ) {
117 case LDAP_FILTER_PRESENT:
118 if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
119 *prefixp = presence_key;
124 case LDAP_FILTER_APPROX:
125 if ( desc->ad_type->sat_approx ) {
126 if( IS_SLAP_INDEX( mask, SLAP_INDEX_APPROX ) ) {
132 /* Use EQUALITY rule and index for approximate match */
135 case LDAP_FILTER_EQUALITY:
136 if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
141 case LDAP_FILTER_SUBSTRINGS:
142 if( IS_SLAP_INDEX( mask, SLAP_INDEX_SUBSTR ) ) {
151 return LDAP_INAPPROPRIATE_MATCHING;
162 AttributeDescription *ad,
163 struct berval *atname,
175 rc = bdb_db_cache( op->o_bd, atname->bv_val, &db );
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 );
184 if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
185 rc = bdb_key_change( op->o_bd, db, txn, &presence_key, id, opid );
191 if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
192 rc = ad->ad_type->sat_equality->smr_indexer(
193 LDAP_FILTER_EQUALITY,
195 ad->ad_type->sat_syntax,
196 ad->ad_type->sat_equality,
197 atname, vals, &keys, op->o_tmpmemctx );
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 );
203 ber_bvarray_free_x( keys, op->o_tmpmemctx );
207 ber_bvarray_free_x( keys, op->o_tmpmemctx );
212 if( IS_SLAP_INDEX( mask, SLAP_INDEX_APPROX ) ) {
213 rc = ad->ad_type->sat_approx->smr_indexer(
216 ad->ad_type->sat_syntax,
217 ad->ad_type->sat_approx,
218 atname, vals, &keys, op->o_tmpmemctx );
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 );
224 ber_bvarray_free_x( keys, op->o_tmpmemctx );
228 ber_bvarray_free_x( keys, op->o_tmpmemctx );
234 if( IS_SLAP_INDEX( mask, SLAP_INDEX_SUBSTR ) ) {
235 rc = ad->ad_type->sat_substr->smr_indexer(
236 LDAP_FILTER_SUBSTRINGS,
238 ad->ad_type->sat_syntax,
239 ad->ad_type->sat_substr,
240 atname, vals, &keys, op->o_tmpmemctx );
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 );
246 ber_bvarray_free_x( keys, op->o_tmpmemctx );
250 ber_bvarray_free_x( keys, op->o_tmpmemctx );
260 static int index_at_values(
263 AttributeDescription *ad,
271 slap_mask_t mask = 0;
275 if ( opid == BDB_INDEX_UPDATE_OP )
276 ixop = SLAP_INDEX_ADD_OP;
278 if( type->sat_sup ) {
280 rc = index_at_values( op, txn, NULL,
287 /* If this type has no AD, we've never used it before */
289 ai = bdb_attr_mask( op->o_bd->be_private, type->sat_ad );
291 #ifdef LDAP_COMP_MATCH
292 /* component indexing */
294 ComponentReference *cr;
295 for( cr = ai->ai_cr ; cr ; cr = cr->cr_next ) {
296 rc = indexer( op, txn, cr->cr_ad, &type->sat_cname,
297 cr->cr_nvals, id, ixop,
303 /* If we're updating the index, just set the new bits that aren't
304 * already in the old mask.
306 if ( opid == BDB_INDEX_UPDATE_OP )
307 mask = ai->ai_newmask & ~ai->ai_indexmask;
309 /* For regular updates, if there is a newmask use it. Otherwise
310 * just use the old mask.
312 mask = ai->ai_newmask ? ai->ai_newmask : ai->ai_indexmask;
314 rc = indexer( op, txn, ad, &type->sat_cname,
315 vals, id, ixop, mask );
323 AttributeDescription *desc;
325 desc = ad_find_tags( type, tags );
327 ai = bdb_attr_mask( op->o_bd->be_private, desc );
330 if ( opid == BDB_INDEX_UPDATE_OP )
331 mask = ai->ai_newmask & ~ai->ai_indexmask;
333 mask = ai->ai_newmask ? ai->ai_newmask : ai->ai_indexmask;
335 rc = indexer( op, txn, desc, &desc->ad_cname,
336 vals, id, ixop, mask );
349 int bdb_index_values(
352 AttributeDescription *desc,
359 /* Never index ID 0 */
363 rc = index_at_values( op, txn, desc,
364 desc->ad_type, &desc->ad_tags,
378 Attribute *ap = e->e_attrs;
379 #ifdef LDAP_COMP_MATCH
380 ComponentReference *cr_list = NULL;
381 ComponentReference *cr = NULL, *dupped_cr = NULL;
382 void* decoded_comp, *extracted_comp;
383 ComponentSyntaxInfo* csi_attr;
388 struct berval value = {0};
391 Debug( LDAP_DEBUG_TRACE, "=> index_entry_%s( %ld, \"%s\" )\n",
392 opid == SLAP_INDEX_DELETE_OP ? "del" : "add",
393 (long) e->e_id, e->e_dn );
395 /* add each attribute to the indexes */
396 for ( ; ap != NULL; ap = ap->a_next ) {
397 #ifdef LDAP_COMP_MATCH
399 /* see if attribute has components to be indexed */
400 ai = bdb_attr_mask( op->o_bd->be_private, ap->a_desc->ad_type->sat_ad );
401 if ( ai ) cr_list = ai->ai_cr;
403 if ( attr_converter && cr_list ) {
404 syn = ap->a_desc->ad_type->sat_syntax;
405 ap->a_comp_data = op->o_tmpalloc( sizeof( ComponentData ), op->o_tmpmemctx );
406 /* Memory chunk(nibble) pre-allocation for decoders */
407 mem_op = nibble_mem_allocator ( 1024*16, 1024*4 );
408 ap->a_comp_data->cd_mem_op = mem_op;
409 for( cr = cr_list ; cr ; cr = cr->cr_next ) {
410 /* count how many values in an attribute */
411 for( num_attr=0; ap->a_vals[num_attr].bv_val != NULL; num_attr++ );
413 cr->cr_nvals = (BerVarray)op->o_tmpalloc( sizeof( struct berval )*num_attr, op->o_tmpmemctx );
414 for( i=0; ap->a_vals[i].bv_val != NULL; i++ ) {
415 /* decoding attribute value */
416 decoded_comp = attr_converter ( ap, syn, &ap->a_vals[i] );
418 return LDAP_DECODING_ERROR;
419 /* extracting the referenced component */
420 dupped_cr = dup_comp_ref( op, cr );
421 csi_attr = ((ComponentSyntaxInfo*)decoded_comp)->csi_comp_desc->cd_extract_i( mem_op, dupped_cr, decoded_comp );
423 return LDAP_DECODING_ERROR;
424 cr->cr_asn_type_id = csi_attr->csi_comp_desc->cd_type_id;
425 cr->cr_ad = (AttributeDescription*)get_component_description ( cr->cr_asn_type_id );
427 return LDAP_INVALID_SYNTAX;
428 at = cr->cr_ad->ad_type;
429 /* encoding the value of component in GSER */
430 rc = component_encoder( mem_op, csi_attr, &value );
431 if ( rc != LDAP_SUCCESS )
432 return LDAP_ENCODING_ERROR;
433 /* Normalize the encoded component values */
434 if ( at->sat_equality && at->sat_equality->smr_normalize ) {
435 rc = at->sat_equality->smr_normalize (
436 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
437 at->sat_syntax, at->sat_equality,
438 &value, &cr->cr_nvals[i], op->o_tmpmemctx );
440 cr->cr_nvals[i] = value;
443 /* The end of BerVarray */
444 cr->cr_nvals[num_attr-1].bv_val = NULL;
445 cr->cr_nvals[num_attr-1].bv_len = 0;
447 op->o_tmpfree( ap->a_comp_data, op->o_tmpmemctx );
448 nibble_mem_free ( mem_op );
449 ap->a_comp_data = NULL;
452 rc = bdb_index_values( op, txn, ap->a_desc,
453 ap->a_nvals, e->e_id, opid );
455 if( rc != LDAP_SUCCESS ) {
456 Debug( LDAP_DEBUG_TRACE,
457 "<= index_entry_%s( %ld, \"%s\" ) failure\n",
458 opid == SLAP_INDEX_ADD_OP ? "add" : "del",
459 (long) e->e_id, e->e_dn );
464 Debug( LDAP_DEBUG_TRACE, "<= index_entry_%s( %ld, \"%s\" ) success\n",
465 opid == SLAP_INDEX_DELETE_OP ? "del" : "add",
466 (long) e->e_id, e->e_dn );