1 /* tools.c - tools for slap tools */
3 /* This work is part of OpenLDAP Software <http://www.openldap.org/>.
5 * Copyright 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>.
20 #include <ac/string.h>
27 static MDB_txn *txn = NULL, *txi = NULL;
28 static MDB_cursor *cursor = NULL, *idcursor = NULL;
29 static MDB_val key, data;
30 static ID previd = NOID;
32 typedef struct dn_id {
37 #define HOLE_SIZE 4096
38 static dn_id hbuf[HOLE_SIZE], *holes = hbuf;
39 static unsigned nhmax = HOLE_SIZE;
40 static unsigned nholes;
42 static struct berval *tool_base;
43 static int tool_scope;
44 static Filter *tool_filter;
45 static Entry *tool_next_entry;
48 static ID mdb_tool_ix_id;
49 static Operation *mdb_tool_ix_op;
50 static int *mdb_tool_index_threads, mdb_tool_index_tcount;
51 static void *mdb_tool_index_rec;
52 static struct mdb_info *mdb_tool_info;
53 static ldap_pvt_thread_mutex_t mdb_tool_index_mutex;
54 static ldap_pvt_thread_cond_t mdb_tool_index_cond_main;
55 static ldap_pvt_thread_cond_t mdb_tool_index_cond_work;
56 static void * mdb_tool_index_task( void *ctx, void *ptr );
59 static int mdb_writes, mdb_writes_per_commit;
62 mdb_tool_entry_get_int( BackendDB *be, ID id, Entry **ep );
64 int mdb_tool_entry_open(
65 BackendDB *be, int mode )
67 /* In Quick mode, commit once per 1000 entries */
69 if ( slapMode & SLAP_TOOL_QUICK )
70 mdb_writes_per_commit = 1000;
72 mdb_writes_per_commit = 1;
75 /* Set up for threaded slapindex */
76 if (( slapMode & (SLAP_TOOL_QUICK|SLAP_TOOL_READONLY)) == SLAP_TOOL_QUICK ) {
77 if ( !mdb_tool_info ) {
78 ldap_pvt_thread_mutex_init( &mdb_tool_index_mutex );
79 ldap_pvt_thread_cond_init( &mdb_tool_index_cond_main );
80 ldap_pvt_thread_cond_init( &mdb_tool_index_cond_work );
81 if ( mdb->bi_nattrs ) {
83 mdb_tool_index_threads = ch_malloc( slap_tool_thread_max * sizeof( int ));
84 mdb_tool_index_rec = ch_malloc( mdb->bi_nattrs * sizeof( IndexRec ));
85 mdb_tool_index_tcount = slap_tool_thread_max - 1;
86 for (i=1; i<slap_tool_thread_max; i++) {
87 int *ptr = ch_malloc( sizeof( int ));
89 ldap_pvt_thread_pool_submit( &connection_pool,
90 mdb_tool_index_task, ptr );
101 int mdb_tool_entry_close(
105 if ( mdb_tool_info ) {
107 ldap_pvt_thread_mutex_lock( &mdb_tool_index_mutex );
109 /* There might still be some threads starting */
110 while ( mdb_tool_index_tcount ) {
111 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_main,
112 &mdb_tool_index_mutex );
115 mdb_tool_index_tcount = slap_tool_thread_max - 1;
116 ldap_pvt_thread_cond_broadcast( &mdb_tool_index_cond_work );
118 /* Make sure all threads are stopped */
119 while ( mdb_tool_index_tcount ) {
120 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_main,
121 &mdb_tool_index_mutex );
123 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
125 mdb_tool_info = NULL;
127 ch_free( mdb_tool_index_threads );
128 ch_free( mdb_tool_index_rec );
129 mdb_tool_index_tcount = slap_tool_thread_max - 1;
134 mdb_cursor_close( idcursor );
138 mdb_cursor_close( cursor );
142 if ( mdb_txn_commit( txn ))
149 fprintf( stderr, "Error, entries missing!\n");
150 for (i=0; i<nholes; i++) {
151 fprintf(stderr, " entry %ld: %s\n",
152 holes[i].id, holes[i].dn.bv_val);
162 mdb_tool_entry_first_x(
172 return mdb_tool_entry_next( be );
175 ID mdb_tool_entry_next(
180 struct mdb_info *mdb;
182 assert( be != NULL );
183 assert( slapMode & SLAP_TOOL_MODE );
185 mdb = (struct mdb_info *) be->be_private;
186 assert( mdb != NULL );
189 rc = mdb_txn_begin( mdb->mi_dbenv, MDB_RDONLY, &txn );
192 rc = mdb_cursor_open( txn, mdb->mi_id2entry, &cursor );
194 mdb_txn_abort( txn );
200 rc = mdb_cursor_get( cursor, &key, &data, MDB_NEXT );
206 previd = *(ID *)key.mv_data;
209 if ( tool_filter || tool_base ) {
210 static Operation op = {0};
211 static Opheader ohdr = {0};
215 op.o_tmpmemctx = NULL;
216 op.o_tmpmfuncs = &ch_mfuncs;
218 if ( tool_next_entry ) {
219 mdb_entry_release( &op, tool_next_entry, 0 );
220 tool_next_entry = NULL;
223 rc = mdb_tool_entry_get_int( be, id, &tool_next_entry );
224 if ( rc == LDAP_NO_SUCH_OBJECT ) {
228 assert( tool_next_entry != NULL );
230 if ( tool_filter && test_filter( NULL, tool_next_entry, tool_filter ) != LDAP_COMPARE_TRUE )
232 mdb_entry_release( &op, tool_next_entry, 0 );
233 tool_next_entry = NULL;
241 ID mdb_tool_dn2id_get(
246 struct mdb_info *mdb;
252 if ( BER_BVISEMPTY(dn) )
255 mdb = (struct mdb_info *) be->be_private;
258 rc = mdb_txn_begin( mdb->mi_dbenv, (slapMode & SLAP_TOOL_READONLY) != 0 ?
259 MDB_RDONLY : 0, &txn );
266 op.o_tmpmemctx = NULL;
267 op.o_tmpmfuncs = &ch_mfuncs;
269 rc = mdb_dn2id( &op, txn, dn, &id, NULL, NULL );
270 if ( rc == MDB_NOTFOUND )
277 mdb_tool_entry_get_int( BackendDB *be, ID id, Entry **ep )
283 struct berval dn = BER_BVNULL, ndn = BER_BVNULL;
286 assert( be != NULL );
287 assert( slapMode & SLAP_TOOL_MODE );
289 if ( ( tool_filter || tool_base ) && id == previd && tool_next_entry != NULL ) {
290 *ep = tool_next_entry;
291 tool_next_entry = NULL;
295 if ( id != previd ) {
296 key.mv_size = sizeof(ID);
298 rc = mdb_cursor_get( cursor, &key, &data, MDB_SET );
307 op.o_tmpmemctx = NULL;
308 op.o_tmpmfuncs = &ch_mfuncs;
309 if ( slapMode & SLAP_TOOL_READONLY ) {
310 rc = mdb_id2name( &op, txn, &idcursor, id, &dn, &ndn );
313 mdb_entry_return( &op, e );
317 if ( tool_base != NULL ) {
318 if ( !dnIsSuffixScope( &ndn, tool_base, tool_scope ) ) {
319 ch_free( dn.bv_val );
320 ch_free( ndn.bv_val );
321 rc = LDAP_NO_SUCH_OBJECT;
325 rc = mdb_entry_decode( &op, &data, &e );
327 if ( !BER_BVISNULL( &dn )) {
331 e->e_name.bv_val = NULL;
332 e->e_nname.bv_val = NULL;
344 mdb_tool_entry_get( BackendDB *be, ID id )
348 (void)mdb_tool_entry_get_int( be, id, &e );
352 static int mdb_tool_next_id(
359 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
360 struct berval dn = e->e_name;
361 struct berval ndn = e->e_nname;
362 struct berval pdn, npdn, nmatched;
366 if (ndn.bv_len == 0) {
371 rc = mdb_dn2id( op, tid, &ndn, &id, NULL, &nmatched );
372 if ( rc == MDB_NOTFOUND ) {
373 if ( !be_issuffix( op->o_bd, &ndn ) ) {
375 dnParent( &ndn, &npdn );
376 if ( nmatched.bv_len != npdn.bv_len ) {
377 dnParent( &dn, &pdn );
380 rc = mdb_tool_next_id( op, tid, e, text, 1 );
386 /* If parent didn't exist, it was created just now
387 * and its ID is now in e->e_id. Make sure the current
388 * entry gets added under the new parent ID.
390 if ( eid != e->e_id ) {
397 rc = mdb_next_id( op->o_bd, tid, &e->e_id );
399 snprintf( text->bv_val, text->bv_len,
400 "next_id failed: %s (%d)",
401 mdb_strerror(rc), rc );
402 Debug( LDAP_DEBUG_ANY,
403 "=> mdb_tool_next_id: %s\n", text->bv_val, 0, 0 );
406 rc = mdb_dn2id_add( op, tid, pid, e );
408 snprintf( text->bv_val, text->bv_len,
409 "dn2id_add failed: %s (%d)",
410 mdb_strerror(rc), rc );
411 Debug( LDAP_DEBUG_ANY,
412 "=> mdb_tool_next_id: %s\n", text->bv_val, 0, 0 );
415 if ( nholes == nhmax - 1 ) {
416 if ( holes == hbuf ) {
417 holes = ch_malloc( nhmax * sizeof(dn_id) * 2 );
418 AC_MEMCPY( holes, hbuf, sizeof(hbuf) );
420 holes = ch_realloc( holes, nhmax * sizeof(dn_id) * 2 );
424 ber_dupbv( &holes[nholes].dn, &ndn );
425 holes[nholes++].id = e->e_id;
426 key.mv_size = sizeof(ID);
427 key.mv_data = &e->e_id;
430 rc = mdb_put( tid, mdb->mi_id2entry, &key, &data, MDB_NOOVERWRITE );
431 if ( rc == MDB_KEYEXIST )
434 snprintf( text->bv_val, text->bv_len,
435 "dummy id2entry add failed: %s (%d)",
436 mdb_strerror(rc), rc );
437 Debug( LDAP_DEBUG_ANY,
438 "=> mdb_tool_next_id: %s\n", text->bv_val, 0, 0 );
441 } else if ( !hole ) {
446 for ( i=0; i<nholes; i++) {
447 if ( holes[i].id == e->e_id ) {
448 free(holes[i].dn.bv_val);
449 for (j=i;j<nholes;j++) holes[j] = holes[j+1];
453 } else if ( holes[i].id > e->e_id ) {
467 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
469 if ( !mdb->mi_nattrs )
473 if ( slapMode & SLAP_TOOL_QUICK ) {
478 ir = mdb_tool_index_rec;
479 memset(ir, 0, mdb->bi_nattrs * sizeof( IndexRec ));
481 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
482 rc = mdb_index_recset( mdb, a, a->a_desc->ad_type,
483 &a->a_desc->ad_tags, ir );
487 mdb_tool_ix_id = e->e_id;
489 ldap_pvt_thread_mutex_lock( &mdb_tool_index_mutex );
490 /* Wait for all threads to be ready */
491 while ( mdb_tool_index_tcount ) {
492 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_main,
493 &mdb_tool_index_mutex );
495 for ( i=1; i<slap_tool_thread_max; i++ )
496 mdb_tool_index_threads[i] = LDAP_BUSY;
497 mdb_tool_index_tcount = slap_tool_thread_max - 1;
498 ldap_pvt_thread_cond_broadcast( &mdb_tool_index_cond_work );
499 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
500 rc = mdb_index_recrun( op, mdb, ir, e->e_id, 0 );
503 ldap_pvt_thread_mutex_lock( &mdb_tool_index_mutex );
504 for ( i=1; i<slap_tool_thread_max; i++ ) {
505 if ( mdb_tool_index_threads[i] == LDAP_BUSY ) {
506 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_main,
507 &mdb_tool_index_mutex );
511 if ( mdb_tool_index_threads[i] ) {
512 rc = mdb_tool_index_threads[i];
516 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
521 return mdb_index_entry_add( op, txn, e );
525 ID mdb_tool_entry_put(
528 struct berval *text )
531 struct mdb_info *mdb;
535 assert( be != NULL );
536 assert( slapMode & SLAP_TOOL_MODE );
538 assert( text != NULL );
539 assert( text->bv_val != NULL );
540 assert( text->bv_val[0] == '\0' ); /* overconservative? */
542 Debug( LDAP_DEBUG_TRACE, "=> " LDAP_XSTRING(mdb_tool_entry_put)
543 "( %ld, \"%s\" )\n", (long) e->e_id, e->e_dn, 0 );
545 mdb = (struct mdb_info *) be->be_private;
548 rc = mdb_txn_begin( mdb->mi_dbenv, 0, &txn );
550 snprintf( text->bv_val, text->bv_len,
551 "txn_begin failed: %s (%d)",
552 mdb_strerror(rc), rc );
553 Debug( LDAP_DEBUG_ANY,
554 "=> " LDAP_XSTRING(mdb_tool_entry_put) ": %s\n",
555 text->bv_val, 0, 0 );
562 op.o_tmpmemctx = NULL;
563 op.o_tmpmfuncs = &ch_mfuncs;
565 /* add dn2id indices */
566 rc = mdb_tool_next_id( &op, txn, e, text, 0 );
571 rc = mdb_tool_index_add( &op, txn, e );
573 snprintf( text->bv_val, text->bv_len,
574 "index_entry_add failed: err=%d", rc );
575 Debug( LDAP_DEBUG_ANY,
576 "=> " LDAP_XSTRING(mdb_tool_entry_put) ": %s\n",
577 text->bv_val, 0, 0 );
583 rc = mdb_id2entry_add( &op, txn, e );
585 snprintf( text->bv_val, text->bv_len,
586 "id2entry_add failed: err=%d", rc );
587 Debug( LDAP_DEBUG_ANY,
588 "=> " LDAP_XSTRING(mdb_tool_entry_put) ": %s\n",
589 text->bv_val, 0, 0 );
596 if ( mdb_writes >= mdb_writes_per_commit ) {
597 rc = mdb_txn_commit( txn );
601 snprintf( text->bv_val, text->bv_len,
602 "txn_commit failed: %s (%d)",
603 mdb_strerror(rc), rc );
604 Debug( LDAP_DEBUG_ANY,
605 "=> " LDAP_XSTRING(mdb_tool_entry_put) ": %s\n",
606 text->bv_val, 0, 0 );
612 mdb_txn_abort( txn );
614 snprintf( text->bv_val, text->bv_len,
615 "txn_aborted! %s (%d)",
616 rc == LDAP_OTHER ? "Internal error" :
617 mdb_strerror(rc), rc );
618 Debug( LDAP_DEBUG_ANY,
619 "=> " LDAP_XSTRING(mdb_tool_entry_put) ": %s\n",
620 text->bv_val, 0, 0 );
627 int mdb_tool_entry_reindex(
630 AttributeDescription **adv )
632 struct mdb_info *mi = (struct mdb_info *) be->be_private;
638 Debug( LDAP_DEBUG_ARGS,
639 "=> " LDAP_XSTRING(mdb_tool_entry_reindex) "( %ld )\n",
641 assert( tool_base == NULL );
642 assert( tool_filter == NULL );
644 /* No indexes configured, nothing to do. Could return an
645 * error here to shortcut things.
651 /* Check for explicit list of attrs to index */
655 if ( mi->mi_attrs[0]->ai_desc != adv[0] ) {
657 for ( n = 0; adv[n]; n++ ) ;
660 for ( i = 0; i < n; i++ ) {
661 AttributeDescription *ad = adv[i];
662 for ( j = i-1; j>=0; j--) {
663 if ( SLAP_PTRCMP( adv[j], ad ) <= 0 ) break;
670 for ( i = 0; adv[i]; i++ ) {
671 if ( mi->mi_attrs[i]->ai_desc != adv[i] ) {
672 for ( j = i+1; j < mi->mi_nattrs; j++ ) {
673 if ( mi->mi_attrs[j]->ai_desc == adv[i] ) {
674 AttrInfo *ai = mi->mi_attrs[i];
675 mi->mi_attrs[i] = mi->mi_attrs[j];
676 mi->mi_attrs[j] = ai;
680 if ( j == mi->mi_nattrs ) {
681 Debug( LDAP_DEBUG_ANY,
682 LDAP_XSTRING(mdb_tool_entry_reindex)
683 ": no index configured for %s\n",
684 adv[i]->ad_cname.bv_val, 0, 0 );
692 e = mdb_tool_entry_get( be, id );
695 Debug( LDAP_DEBUG_ANY,
696 LDAP_XSTRING(mdb_tool_entry_reindex)
697 ": could not locate id=%ld\n",
703 rc = mdb_txn_begin( mi->mi_dbenv, 0, &txi );
705 Debug( LDAP_DEBUG_ANY,
706 "=> " LDAP_XSTRING(mdb_tool_entry_reindex) ": "
707 "txn_begin failed: %s (%d)\n",
708 mdb_strerror(rc), rc, 0 );
714 * just (re)add them for now
715 * assume that some other routine (not yet implemented)
716 * will zap index databases
720 Debug( LDAP_DEBUG_TRACE,
721 "=> " LDAP_XSTRING(mdb_tool_entry_reindex) "( %ld, \"%s\" )\n",
722 (long) id, e->e_dn, 0 );
726 op.o_tmpmemctx = NULL;
727 op.o_tmpmfuncs = &ch_mfuncs;
729 rc = mdb_tool_index_add( &op, txi, e );
734 if ( mdb_writes >= mdb_writes_per_commit ) {
735 rc = mdb_txn_commit( txi );
737 Debug( LDAP_DEBUG_ANY,
738 "=> " LDAP_XSTRING(mdb_tool_entry_reindex)
739 ": txn_commit failed: %s (%d)\n",
740 mdb_strerror(rc), rc, 0 );
747 mdb_txn_abort( txi );
748 Debug( LDAP_DEBUG_ANY,
749 "=> " LDAP_XSTRING(mdb_tool_entry_reindex)
750 ": txn_aborted! err=%d\n",
755 mdb_entry_release( &op, e, 0 );
760 ID mdb_tool_entry_modify(
763 struct berval *text )
766 struct mdb_info *mdb;
771 assert( be != NULL );
772 assert( slapMode & SLAP_TOOL_MODE );
774 assert( text != NULL );
775 assert( text->bv_val != NULL );
776 assert( text->bv_val[0] == '\0' ); /* overconservative? */
778 assert ( e->e_id != NOID );
780 Debug( LDAP_DEBUG_TRACE,
781 "=> " LDAP_XSTRING(mdb_tool_entry_modify) "( %ld, \"%s\" )\n",
782 (long) e->e_id, e->e_dn, 0 );
784 mdb = (struct mdb_info *) be->be_private;
787 mdb_cursor_close( cursor );
790 rc = mdb_txn_begin( mdb->mi_dbenv, 0, &tid );
792 snprintf( text->bv_val, text->bv_len,
793 "txn_begin failed: %s (%d)",
794 mdb_strerror(rc), rc );
795 Debug( LDAP_DEBUG_ANY,
796 "=> " LDAP_XSTRING(mdb_tool_entry_modify) ": %s\n",
797 text->bv_val, 0, 0 );
803 op.o_tmpmemctx = NULL;
804 op.o_tmpmfuncs = &ch_mfuncs;
807 rc = mdb_id2entry_update( &op, tid, e );
809 snprintf( text->bv_val, text->bv_len,
810 "id2entry_update failed: err=%d", rc );
811 Debug( LDAP_DEBUG_ANY,
812 "=> " LDAP_XSTRING(mdb_tool_entry_modify) ": %s\n",
813 text->bv_val, 0, 0 );
819 rc = mdb_txn_commit( tid );
821 snprintf( text->bv_val, text->bv_len,
822 "txn_commit failed: %s (%d)",
823 mdb_strerror(rc), rc );
824 Debug( LDAP_DEBUG_ANY,
825 "=> " LDAP_XSTRING(mdb_tool_entry_modify) ": "
826 "%s\n", text->bv_val, 0, 0 );
831 mdb_txn_abort( tid );
832 snprintf( text->bv_val, text->bv_len,
833 "txn_aborted! %s (%d)",
834 mdb_strerror(rc), rc );
835 Debug( LDAP_DEBUG_ANY,
836 "=> " LDAP_XSTRING(mdb_tool_entry_modify) ": %s\n",
837 text->bv_val, 0, 0 );
846 mdb_tool_index_task( void *ctx, void *ptr )
848 int base = *(int *)ptr;
852 ldap_pvt_thread_mutex_lock( &mdb_tool_index_mutex );
853 mdb_tool_index_tcount--;
854 if ( !mdb_tool_index_tcount )
855 ldap_pvt_thread_cond_signal( &mdb_tool_index_cond_main );
856 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_work,
857 &mdb_tool_index_mutex );
858 if ( slapd_shutdown ) {
859 mdb_tool_index_tcount--;
860 if ( !mdb_tool_index_tcount )
861 ldap_pvt_thread_cond_signal( &mdb_tool_index_cond_main );
862 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
865 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
867 mdb_tool_index_threads[base] = mdb_index_recrun( mdb_tool_ix_op,
868 mdb_tool_info, mdb_tool_index_rec, mdb_tool_ix_id, base );