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 slap_mask_t index_mask(
33 AttributeDescription *desc,
34 struct berval *atname )
39 bdb_attr_mask( be->be_private, desc, &mask );
42 *atname = desc->ad_cname;
46 /* If there is a tagging option, did we ever index the base
47 * type? If so, check for mask, otherwise it's not there.
49 if( slap_ad_is_tagged( desc ) && desc != desc->ad_type->sat_ad ) {
50 /* has tagging option */
51 bdb_attr_mask( be->be_private, desc->ad_type->sat_ad, &mask );
53 if ( mask && ( mask ^ SLAP_INDEX_NOTAGS ) ) {
54 *atname = desc->ad_type->sat_cname;
59 /* see if supertype defined mask for its subtypes */
60 for( at = desc->ad_type; at != NULL ; at = at->sat_sup ) {
61 /* If no AD, we've never indexed this type */
62 if ( !at->sat_ad ) continue;
64 bdb_attr_mask( be->be_private, at->sat_ad, &mask );
66 if ( mask && ( mask ^ SLAP_INDEX_NOSUBTYPES ) ) {
67 *atname = at->sat_cname;
75 int bdb_index_is_indexed(
77 AttributeDescription *desc )
82 mask = index_mask( be, desc, &prefix );
85 return LDAP_INAPPROPRIATE_MATCHING;
93 AttributeDescription *desc,
97 struct berval *prefixp )
103 mask = index_mask( be, desc, prefixp );
106 return LDAP_INAPPROPRIATE_MATCHING;
109 rc = bdb_db_cache( be, prefixp->bv_val, &db );
111 if( rc != LDAP_SUCCESS ) {
116 case LDAP_FILTER_PRESENT:
117 if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
118 *prefixp = presence_key;
123 case LDAP_FILTER_APPROX:
124 if ( desc->ad_type->sat_approx ) {
125 if( IS_SLAP_INDEX( mask, SLAP_INDEX_APPROX ) ) {
131 /* Use EQUALITY rule and index for approximate match */
134 case LDAP_FILTER_EQUALITY:
135 if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
140 case LDAP_FILTER_SUBSTRINGS:
141 if( IS_SLAP_INDEX( mask, SLAP_INDEX_SUBSTR ) ) {
150 return LDAP_INAPPROPRIATE_MATCHING;
161 AttributeDescription *ad,
162 struct berval *atname,
174 rc = bdb_db_cache( op->o_bd, atname->bv_val, &db );
176 if ( rc != LDAP_SUCCESS ) {
177 Debug( LDAP_DEBUG_ANY,
178 "bdb_index_read: Could not open DB %s\n",
179 atname->bv_val, 0, 0 );
183 if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
184 rc = bdb_key_change( op->o_bd, db, txn, &presence_key, id, opid );
190 if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
191 rc = ad->ad_type->sat_equality->smr_indexer(
192 LDAP_FILTER_EQUALITY,
194 ad->ad_type->sat_syntax,
195 ad->ad_type->sat_equality,
196 atname, vals, &keys, op->o_tmpmemctx );
198 if( rc == LDAP_SUCCESS && keys != NULL ) {
199 for( i=0; keys[i].bv_val != NULL; i++ ) {
200 rc = bdb_key_change( op->o_bd, db, txn, &keys[i], id, opid );
202 ber_bvarray_free_x( keys, op->o_tmpmemctx );
206 ber_bvarray_free_x( keys, op->o_tmpmemctx );
211 if( IS_SLAP_INDEX( mask, SLAP_INDEX_APPROX ) ) {
212 rc = ad->ad_type->sat_approx->smr_indexer(
215 ad->ad_type->sat_syntax,
216 ad->ad_type->sat_approx,
217 atname, vals, &keys, op->o_tmpmemctx );
219 if( rc == LDAP_SUCCESS && keys != NULL ) {
220 for( i=0; keys[i].bv_val != NULL; i++ ) {
221 rc = bdb_key_change( op->o_bd, db, txn, &keys[i], id, opid );
223 ber_bvarray_free_x( keys, op->o_tmpmemctx );
227 ber_bvarray_free_x( keys, op->o_tmpmemctx );
233 if( IS_SLAP_INDEX( mask, SLAP_INDEX_SUBSTR ) ) {
234 rc = ad->ad_type->sat_substr->smr_indexer(
235 LDAP_FILTER_SUBSTRINGS,
237 ad->ad_type->sat_syntax,
238 ad->ad_type->sat_substr,
239 atname, vals, &keys, op->o_tmpmemctx );
241 if( rc == LDAP_SUCCESS && keys != NULL ) {
242 for( i=0; keys[i].bv_val != NULL; i++ ) {
243 rc = bdb_key_change( op->o_bd, db, txn, &keys[i], id, opid );
245 ber_bvarray_free_x( keys, op->o_tmpmemctx );
249 ber_bvarray_free_x( keys, op->o_tmpmemctx );
259 static int index_at_values(
262 AttributeDescription *ad,
270 slap_mask_t mask = 0;
272 if( type->sat_sup ) {
274 rc = index_at_values( op, txn, NULL,
281 /* If this type has no AD, we've never used it before */
283 #ifdef LDAP_COMP_MATCH
284 /* component indexing */
285 ComponentReference* cr_list, *cr;
287 bdb_attr_mask_cr( op->o_bd->be_private, type->sat_ad, &mask, &cr_list );
289 for( cr = cr_list ; cr ; cr = cr->cr_next ) {
290 rc = indexer( op, txn, cr->cr_ad, &type->sat_cname,
291 cr->cr_nvals, id, opid,
296 bdb_attr_mask( op->o_bd->be_private, type->sat_ad, &mask );
302 rc = indexer( op, txn, ad, &type->sat_cname,
310 AttributeDescription *desc;
314 desc = ad_find_tags( type, tags );
316 bdb_attr_mask( op->o_bd->be_private, desc, &mask );
320 rc = indexer( op, txn, desc, &desc->ad_cname,
333 int bdb_index_values(
336 AttributeDescription *desc,
343 /* Never index ID 0 */
347 rc = index_at_values( op, txn, desc,
348 desc->ad_type, &desc->ad_tags,
362 Attribute *ap = e->e_attrs;
363 #ifdef LDAP_COMP_MATCH
364 ComponentReference *cr_list = NULL;
365 ComponentReference *cr = NULL, *dupped_cr = NULL;
366 void* decoded_comp, *extracted_comp;
367 ComponentSyntaxInfo* csi_attr;
372 struct berval value = {0};
375 Debug( LDAP_DEBUG_TRACE, "=> index_entry_%s( %ld, \"%s\" )\n",
376 opid == SLAP_INDEX_ADD_OP ? "add" : "del",
377 (long) e->e_id, e->e_dn );
379 /* add each attribute to the indexes */
380 for ( ; ap != NULL; ap = ap->a_next ) {
381 #ifdef LDAP_COMP_MATCH
382 /* see if attribute has components to be indexed */
383 bdb_attr_comp_ref( op->o_bd->be_private, ap->a_desc->ad_type->sat_ad, &cr_list );
384 if ( attr_converter && cr_list ) {
385 syn = ap->a_desc->ad_type->sat_syntax;
386 ap->a_comp_data = op->o_tmpalloc( sizeof( ComponentData ), op->o_tmpmemctx );
387 /* Memory chunk(nibble) pre-allocation for decoders */
388 mem_op = nibble_mem_allocator ( 1024*16, 1024*4 );
389 ap->a_comp_data->cd_mem_op = mem_op;
390 for( cr = cr_list ; cr ; cr = cr->cr_next ) {
391 /* count how many values in an attribute */
392 for( num_attr=0; ap->a_vals[num_attr].bv_val != NULL; num_attr++ );
394 cr->cr_nvals = (BerVarray)op->o_tmpalloc( sizeof( struct berval )*num_attr, op->o_tmpmemctx );
395 for( i=0; ap->a_vals[i].bv_val != NULL; i++ ) {
396 /* decoding attribute value */
397 decoded_comp = attr_converter ( ap, syn, &ap->a_vals[i] );
399 return LDAP_DECODING_ERROR;
400 /* extracting the referenced component */
401 dupped_cr = dup_comp_ref( op, cr );
402 csi_attr = ((ComponentSyntaxInfo*)decoded_comp)->csi_comp_desc->cd_extract_i( mem_op, dupped_cr, decoded_comp );
404 return LDAP_DECODING_ERROR;
405 cr->cr_asn_type_id = csi_attr->csi_comp_desc->cd_type_id;
406 cr->cr_ad = (AttributeDescription*)get_component_description ( cr->cr_asn_type_id );
408 return LDAP_INVALID_SYNTAX;
409 at = cr->cr_ad->ad_type;
410 /* encoding the value of component in GSER */
411 rc = component_encoder( mem_op, csi_attr, &value );
412 if ( rc != LDAP_SUCCESS )
413 return LDAP_ENCODING_ERROR;
414 /* Normalize the encoded component values */
415 if ( at->sat_equality && at->sat_equality->smr_normalize ) {
416 rc = at->sat_equality->smr_normalize (
417 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
418 at->sat_syntax, at->sat_equality,
419 &value, &cr->cr_nvals[i], op->o_tmpmemctx );
421 cr->cr_nvals[i] = value;
424 /* The end of BerVarray */
425 cr->cr_nvals[num_attr-1].bv_val = NULL;
426 cr->cr_nvals[num_attr-1].bv_len = 0;
428 op->o_tmpfree( ap->a_comp_data, op->o_tmpmemctx );
429 nibble_mem_free ( mem_op );
430 ap->a_comp_data = NULL;
433 rc = bdb_index_values( op, txn, ap->a_desc,
434 ap->a_nvals, e->e_id, opid );
436 if( rc != LDAP_SUCCESS ) {
437 Debug( LDAP_DEBUG_TRACE,
438 "<= index_entry_%s( %ld, \"%s\" ) failure\n",
439 opid == SLAP_INDEX_ADD_OP ? "add" : "del",
440 (long) e->e_id, e->e_dn );
445 Debug( LDAP_DEBUG_TRACE, "<= index_entry_%s( %ld, \"%s\" ) success\n",
446 opid == SLAP_INDEX_ADD_OP ? "add" : "del",
447 (long) e->e_id, e->e_dn );