1 /* index.c - routines for dealing with attribute indexes */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 2000-2011 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[] = {0,0};
29 static struct berval presence_key[2] = {BER_BVC(presence_keyval), BER_BVNULL};
31 AttrInfo *mdb_index_mask(
33 AttributeDescription *desc,
34 struct berval *atname )
37 AttrInfo *ai = mdb_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 = mdb_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 = mdb_attr_mask( be->be_private, at->sat_ad );
64 if ( ai && !( ai->ai_indexmask & SLAP_INDEX_NOSUBTYPES ) ) {
65 *atname = at->sat_cname;
73 /* This function is only called when evaluating search filters.
77 AttributeDescription *desc,
81 struct berval *prefixp )
84 slap_mask_t mask, type = 0;
86 ai = mdb_index_mask( be, desc, prefixp );
89 #ifdef MDB_MONITOR_IDX
91 case LDAP_FILTER_PRESENT:
92 type = SLAP_INDEX_PRESENT;
94 case LDAP_FILTER_APPROX:
95 type = SLAP_INDEX_APPROX;
97 case LDAP_FILTER_EQUALITY:
98 type = SLAP_INDEX_EQUALITY;
100 case LDAP_FILTER_SUBSTRINGS:
101 type = SLAP_INDEX_SUBSTR;
104 return LDAP_INAPPROPRIATE_MATCHING;
106 mdb_monitor_idx_add( be->be_private, desc, type );
107 #endif /* MDB_MONITOR_IDX */
109 return LDAP_INAPPROPRIATE_MATCHING;
111 mask = ai->ai_indexmask;
114 case LDAP_FILTER_PRESENT:
115 type = SLAP_INDEX_PRESENT;
116 if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
117 *prefixp = presence_key[0];
122 case LDAP_FILTER_APPROX:
123 type = SLAP_INDEX_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 type = SLAP_INDEX_EQUALITY;
136 if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
141 case LDAP_FILTER_SUBSTRINGS:
142 type = SLAP_INDEX_SUBSTR;
143 if( IS_SLAP_INDEX( mask, SLAP_INDEX_SUBSTR ) ) {
152 #ifdef MDB_MONITOR_IDX
153 mdb_monitor_idx_add( be->be_private, desc, type );
154 #endif /* MDB_MONITOR_IDX */
156 return LDAP_INAPPROPRIATE_MATCHING;
168 AttributeDescription *ad,
169 struct berval *atname,
178 mdb_idl_keyfunc *keyfunc;
182 rc = mdb_cursor_open( txn, dbi, &mc );
185 if ( opid == SLAP_INDEX_ADD_OP )
186 keyfunc = mdb_idl_insert_keys;
188 keyfunc = mdb_idl_delete_keys;
190 if( IS_SLAP_INDEX( mask, SLAP_INDEX_PRESENT ) ) {
191 rc = keyfunc( mc, (MDB_val *)presence_key, id );
197 if( IS_SLAP_INDEX( mask, SLAP_INDEX_EQUALITY ) ) {
198 rc = ad->ad_type->sat_equality->smr_indexer(
199 LDAP_FILTER_EQUALITY,
201 ad->ad_type->sat_syntax,
202 ad->ad_type->sat_equality,
203 atname, vals, &keys, op->o_tmpmemctx );
205 if( rc == LDAP_SUCCESS && keys != NULL ) {
206 rc = keyfunc( mc, (MDB_val *)keys, id );
207 ber_bvarray_free_x( keys, op->o_tmpmemctx );
215 if( IS_SLAP_INDEX( mask, SLAP_INDEX_APPROX ) ) {
216 rc = ad->ad_type->sat_approx->smr_indexer(
219 ad->ad_type->sat_syntax,
220 ad->ad_type->sat_approx,
221 atname, vals, &keys, op->o_tmpmemctx );
223 if( rc == LDAP_SUCCESS && keys != NULL ) {
224 rc = keyfunc( mc, (MDB_val *)keys, id );
225 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 rc = keyfunc( mc, (MDB_val *)keys, id );
244 ber_bvarray_free_x( keys, op->o_tmpmemctx );
254 mdb_cursor_close( mc );
256 /* The callers all know how to deal with these results */
259 /* Anything else is bad news */
266 static int index_at_values(
269 AttributeDescription *ad,
277 slap_mask_t mask = 0;
281 if ( opid == MDB_INDEX_UPDATE_OP )
282 ixop = SLAP_INDEX_ADD_OP;
284 if( type->sat_sup ) {
286 rc = index_at_values( op, txn, NULL,
293 /* If this type has no AD, we've never used it before */
295 ai = mdb_attr_mask( op->o_bd->be_private, type->sat_ad );
297 #ifdef LDAP_COMP_MATCH
298 /* component indexing */
300 ComponentReference *cr;
301 for( cr = ai->ai_cr ; cr ; cr = cr->cr_next ) {
302 rc = indexer( op, txn, ai->ai_dbi, cr->cr_ad, &type->sat_cname,
303 cr->cr_nvals, id, ixop,
309 /* If we're updating the index, just set the new bits that aren't
310 * already in the old mask.
312 if ( opid == MDB_INDEX_UPDATE_OP )
313 mask = ai->ai_newmask & ~ai->ai_indexmask;
315 /* For regular updates, if there is a newmask use it. Otherwise
316 * just use the old mask.
318 mask = ai->ai_newmask ? ai->ai_newmask : ai->ai_indexmask;
320 rc = indexer( op, txn, ai->ai_dbi, ad, &type->sat_cname,
321 vals, id, ixop, mask );
329 AttributeDescription *desc;
331 desc = ad_find_tags( type, tags );
333 ai = mdb_attr_mask( op->o_bd->be_private, desc );
336 if ( opid == MDB_INDEX_UPDATE_OP )
337 mask = ai->ai_newmask & ~ai->ai_indexmask;
339 mask = ai->ai_newmask ? ai->ai_newmask : ai->ai_indexmask;
341 rc = indexer( op, txn, ai->ai_dbi, desc, &desc->ad_cname,
342 vals, id, ixop, mask );
355 int mdb_index_values(
358 AttributeDescription *desc,
365 /* Never index ID 0 */
369 rc = index_at_values( op, txn, desc,
370 desc->ad_type, &desc->ad_tags,
376 /* Get the list of which indices apply to this attr */
379 struct mdb_info *mdb,
388 if( type->sat_sup ) {
390 rc = mdb_index_recset( mdb, a, type->sat_sup, tags, ir );
393 /* If this type has no AD, we've never used it before */
395 slot = mdb_attr_slot( mdb, type->sat_ad, NULL );
397 ir[slot].ai = mdb->mi_attrs[slot];
398 al = ch_malloc( sizeof( AttrList ));
400 al->next = ir[slot].attrs;
405 AttributeDescription *desc;
407 desc = ad_find_tags( type, tags );
409 slot = mdb_attr_slot( mdb, desc, NULL );
411 ir[slot].ai = mdb->mi_attrs[slot];
412 al = ch_malloc( sizeof( AttrList ));
414 al->next = ir[slot].attrs;
422 /* Apply the indices for the recset */
423 int mdb_index_recrun(
425 struct mdb_info *mdb,
434 /* Never index ID 0 */
438 for (i=base; i<mdb->mi_nattrs; i+=slap_tool_thread_max) {
440 if ( !ir->ai ) continue;
441 while (( al = ir->attrs )) {
442 ir->attrs = al->next;
443 rc = indexer( op, NULL, ir->ai->ai_dbi, ir->ai->ai_desc,
444 &ir->ai->ai_desc->ad_type->sat_cname,
445 al->attr->a_nvals, id, SLAP_INDEX_ADD_OP,
446 ir->ai->ai_indexmask );
462 Attribute *ap = e->e_attrs;
463 #if 0 /* ifdef LDAP_COMP_MATCH */
464 ComponentReference *cr_list = NULL;
465 ComponentReference *cr = NULL, *dupped_cr = NULL;
467 ComponentSyntaxInfo* csi_attr;
472 struct berval value = {0};
475 /* Never index ID 0 */
479 Debug( LDAP_DEBUG_TRACE, "=> index_entry_%s( %ld, \"%s\" )\n",
480 opid == SLAP_INDEX_DELETE_OP ? "del" : "add",
481 (long) e->e_id, e->e_dn );
483 /* add each attribute to the indexes */
484 for ( ; ap != NULL; ap = ap->a_next ) {
485 #if 0 /* ifdef LDAP_COMP_MATCH */
487 /* see if attribute has components to be indexed */
488 ai = mdb_attr_mask( op->o_bd->be_private, ap->a_desc->ad_type->sat_ad );
491 if ( attr_converter && cr_list ) {
492 syn = ap->a_desc->ad_type->sat_syntax;
493 ap->a_comp_data = op->o_tmpalloc( sizeof( ComponentData ), op->o_tmpmemctx );
494 /* Memory chunk(nibble) pre-allocation for decoders */
495 mem_op = nibble_mem_allocator ( 1024*16, 1024*4 );
496 ap->a_comp_data->cd_mem_op = mem_op;
497 for( cr = cr_list ; cr ; cr = cr->cr_next ) {
498 /* count how many values in an attribute */
499 for( num_attr=0; ap->a_vals[num_attr].bv_val != NULL; num_attr++ );
501 cr->cr_nvals = (BerVarray)op->o_tmpalloc( sizeof( struct berval )*num_attr, op->o_tmpmemctx );
502 for( i=0; ap->a_vals[i].bv_val != NULL; i++ ) {
503 /* decoding attribute value */
504 decoded_comp = attr_converter ( ap, syn, &ap->a_vals[i] );
506 return LDAP_DECODING_ERROR;
507 /* extracting the referenced component */
508 dupped_cr = dup_comp_ref( op, cr );
509 csi_attr = ((ComponentSyntaxInfo*)decoded_comp)->csi_comp_desc->cd_extract_i( mem_op, dupped_cr, decoded_comp );
511 return LDAP_DECODING_ERROR;
512 cr->cr_asn_type_id = csi_attr->csi_comp_desc->cd_type_id;
513 cr->cr_ad = (AttributeDescription*)get_component_description ( cr->cr_asn_type_id );
515 return LDAP_INVALID_SYNTAX;
516 at = cr->cr_ad->ad_type;
517 /* encoding the value of component in GSER */
518 rc = component_encoder( mem_op, csi_attr, &value );
519 if ( rc != LDAP_SUCCESS )
520 return LDAP_ENCODING_ERROR;
521 /* Normalize the encoded component values */
522 if ( at->sat_equality && at->sat_equality->smr_normalize ) {
523 rc = at->sat_equality->smr_normalize (
524 SLAP_MR_VALUE_OF_ATTRIBUTE_SYNTAX,
525 at->sat_syntax, at->sat_equality,
526 &value, &cr->cr_nvals[i], op->o_tmpmemctx );
528 cr->cr_nvals[i] = value;
531 /* The end of BerVarray */
532 cr->cr_nvals[num_attr-1].bv_val = NULL;
533 cr->cr_nvals[num_attr-1].bv_len = 0;
535 op->o_tmpfree( ap->a_comp_data, op->o_tmpmemctx );
536 nibble_mem_free ( mem_op );
537 ap->a_comp_data = NULL;
540 rc = mdb_index_values( op, txn, ap->a_desc,
541 ap->a_nvals, e->e_id, opid );
543 if( rc != LDAP_SUCCESS ) {
544 Debug( LDAP_DEBUG_TRACE,
545 "<= index_entry_%s( %ld, \"%s\" ) failure\n",
546 opid == SLAP_INDEX_ADD_OP ? "add" : "del",
547 (long) e->e_id, e->e_dn );
552 Debug( LDAP_DEBUG_TRACE, "<= index_entry_%s( %ld, \"%s\" ) success\n",
553 opid == SLAP_INDEX_DELETE_OP ? "del" : "add",
554 (long) e->e_id, e->e_dn );