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 EntryHeader eh;
31 static ID previd = NOID;
33 typedef struct dn_id {
38 #define HOLE_SIZE 4096
39 static dn_id hbuf[HOLE_SIZE], *holes = hbuf;
40 static unsigned nhmax = HOLE_SIZE;
41 static unsigned nholes;
43 static struct berval *tool_base;
44 static int tool_scope;
45 static Filter *tool_filter;
46 static Entry *tool_next_entry;
49 static ID mdb_tool_ix_id;
50 static Operation *mdb_tool_ix_op;
51 static int *mdb_tool_index_threads, mdb_tool_index_tcount;
52 static void *mdb_tool_index_rec;
53 static struct mdb_info *mdb_tool_info;
54 static ldap_pvt_thread_mutex_t mdb_tool_index_mutex;
55 static ldap_pvt_thread_cond_t mdb_tool_index_cond_main;
56 static ldap_pvt_thread_cond_t mdb_tool_index_cond_work;
57 static void * mdb_tool_index_task( void *ctx, void *ptr );
60 static int mdb_writes, mdb_writes_per_commit;
63 mdb_tool_entry_get_int( BackendDB *be, ID id, Entry **ep );
65 int mdb_tool_entry_open(
66 BackendDB *be, int mode )
68 /* In Quick mode, commit once per 1000 entries */
70 if ( slapMode & SLAP_TOOL_QUICK )
71 mdb_writes_per_commit = 1000;
73 mdb_writes_per_commit = 1;
76 /* Set up for threaded slapindex */
77 if (( slapMode & (SLAP_TOOL_QUICK|SLAP_TOOL_READONLY)) == SLAP_TOOL_QUICK ) {
78 if ( !mdb_tool_info ) {
79 ldap_pvt_thread_mutex_init( &mdb_tool_index_mutex );
80 ldap_pvt_thread_cond_init( &mdb_tool_index_cond_main );
81 ldap_pvt_thread_cond_init( &mdb_tool_index_cond_work );
82 if ( mdb->bi_nattrs ) {
84 mdb_tool_index_threads = ch_malloc( slap_tool_thread_max * sizeof( int ));
85 mdb_tool_index_rec = ch_malloc( mdb->bi_nattrs * sizeof( IndexRec ));
86 mdb_tool_index_tcount = slap_tool_thread_max - 1;
87 for (i=1; i<slap_tool_thread_max; i++) {
88 int *ptr = ch_malloc( sizeof( int ));
90 ldap_pvt_thread_pool_submit( &connection_pool,
91 mdb_tool_index_task, ptr );
102 int mdb_tool_entry_close(
106 if ( mdb_tool_info ) {
108 ldap_pvt_thread_mutex_lock( &mdb_tool_index_mutex );
110 /* There might still be some threads starting */
111 while ( mdb_tool_index_tcount ) {
112 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_main,
113 &mdb_tool_index_mutex );
116 mdb_tool_index_tcount = slap_tool_thread_max - 1;
117 ldap_pvt_thread_cond_broadcast( &mdb_tool_index_cond_work );
119 /* Make sure all threads are stopped */
120 while ( mdb_tool_index_tcount ) {
121 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_main,
122 &mdb_tool_index_mutex );
124 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
126 mdb_tool_info = NULL;
128 ch_free( mdb_tool_index_threads );
129 ch_free( mdb_tool_index_rec );
130 mdb_tool_index_tcount = slap_tool_thread_max - 1;
135 mdb_cursor_close( idcursor );
139 mdb_cursor_close( cursor );
143 if ( mdb_txn_commit( txn ))
150 fprintf( stderr, "Error, entries missing!\n");
151 for (i=0; i<nholes; i++) {
152 fprintf(stderr, " entry %ld: %s\n",
153 holes[i].id, holes[i].dn.bv_val);
163 mdb_tool_entry_first_x(
173 return mdb_tool_entry_next( be );
176 ID mdb_tool_entry_next(
181 struct mdb_info *mdb;
183 assert( be != NULL );
184 assert( slapMode & SLAP_TOOL_MODE );
186 mdb = (struct mdb_info *) be->be_private;
187 assert( mdb != NULL );
190 rc = mdb_txn_begin( mdb->mi_dbenv, 1, &txn );
193 rc = mdb_cursor_open( txn, mdb->mi_id2entry, &cursor );
195 mdb_txn_abort( txn );
201 rc = mdb_cursor_get( cursor, &key, &data, MDB_NEXT );
207 previd = *(ID *)key.mv_data;
210 if ( tool_filter || tool_base ) {
211 static Operation op = {0};
212 static Opheader ohdr = {0};
216 op.o_tmpmemctx = NULL;
217 op.o_tmpmfuncs = &ch_mfuncs;
219 if ( tool_next_entry ) {
220 mdb_entry_release( &op, tool_next_entry, 0 );
221 tool_next_entry = NULL;
224 rc = mdb_tool_entry_get_int( be, id, &tool_next_entry );
225 if ( rc == LDAP_NO_SUCH_OBJECT ) {
229 assert( tool_next_entry != NULL );
231 if ( tool_filter && test_filter( NULL, tool_next_entry, tool_filter ) != LDAP_COMPARE_TRUE )
233 mdb_entry_release( &op, tool_next_entry, 0 );
234 tool_next_entry = NULL;
242 ID mdb_tool_dn2id_get(
247 struct mdb_info *mdb;
253 if ( BER_BVISEMPTY(dn) )
256 mdb = (struct mdb_info *) be->be_private;
259 rc = mdb_txn_begin( mdb->mi_dbenv, (slapMode & SLAP_TOOL_READONLY) != 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 )
280 struct berval dn = BER_BVNULL, ndn = BER_BVNULL;
283 assert( be != NULL );
284 assert( slapMode & SLAP_TOOL_MODE );
286 if ( ( tool_filter || tool_base ) && id == previd && tool_next_entry != NULL ) {
287 *ep = tool_next_entry;
288 tool_next_entry = NULL;
292 if ( id != previd ) {
293 key.mv_size = sizeof(ID);
295 rc = mdb_cursor_get( cursor, &key, &data, MDB_SET );
302 if ( slapMode & SLAP_TOOL_READONLY ) {
308 op.o_tmpmemctx = NULL;
309 op.o_tmpmfuncs = &ch_mfuncs;
311 rc = mdb_id2name( &op, txn, &idcursor, id, &dn, &ndn );
314 mdb_entry_return( e );
318 if ( tool_base != NULL ) {
319 if ( !dnIsSuffixScope( &ndn, tool_base, tool_scope ) ) {
320 ch_free( dn.bv_val );
321 ch_free( ndn.bv_val );
322 rc = LDAP_NO_SUCH_OBJECT;
327 eh.bv.bv_val = data.mv_data;
328 eh.bv.bv_len = data.mv_size;
330 rc = entry_header( &eh );
335 eh.bv.bv_len = eh.nvals * sizeof( struct berval );
336 eh.bv.bv_val = ch_malloc( eh.bv.bv_len );
337 rc = entry_decode( &eh, &e );
339 if ( !BER_BVISNULL( &dn )) {
343 e->e_name.bv_val = NULL;
344 e->e_nname.bv_val = NULL;
357 mdb_tool_entry_get( BackendDB *be, ID id )
361 (void)mdb_tool_entry_get_int( be, id, &e );
365 static int mdb_tool_next_id(
372 struct berval dn = e->e_name;
373 struct berval ndn = e->e_nname;
374 struct berval pdn, npdn, nmatched;
378 if (ndn.bv_len == 0) {
383 rc = mdb_dn2id( op, tid, &ndn, &id, NULL, &nmatched );
384 if ( rc == MDB_NOTFOUND ) {
385 if ( !be_issuffix( op->o_bd, &ndn ) ) {
387 dnParent( &ndn, &npdn );
388 if ( nmatched.bv_len != npdn.bv_len ) {
389 dnParent( &dn, &pdn );
392 rc = mdb_tool_next_id( op, tid, e, text, 1 );
398 /* If parent didn't exist, it was created just now
399 * and its ID is now in e->e_id. Make sure the current
400 * entry gets added under the new parent ID.
402 if ( eid != e->e_id ) {
409 rc = mdb_next_id( op->o_bd, tid, &e->e_id );
411 snprintf( text->bv_val, text->bv_len,
412 "next_id failed: %s (%d)",
413 mdb_strerror(rc), rc );
414 Debug( LDAP_DEBUG_ANY,
415 "=> mdb_tool_next_id: %s\n", text->bv_val, 0, 0 );
418 rc = mdb_dn2id_add( op, tid, pid, e );
420 snprintf( text->bv_val, text->bv_len,
421 "dn2id_add failed: %s (%d)",
422 mdb_strerror(rc), rc );
423 Debug( LDAP_DEBUG_ANY,
424 "=> mdb_tool_next_id: %s\n", text->bv_val, 0, 0 );
426 if ( nholes == nhmax - 1 ) {
427 if ( holes == hbuf ) {
428 holes = ch_malloc( nhmax * sizeof(dn_id) * 2 );
429 AC_MEMCPY( holes, hbuf, sizeof(hbuf) );
431 holes = ch_realloc( holes, nhmax * sizeof(dn_id) * 2 );
435 ber_dupbv( &holes[nholes].dn, &ndn );
436 holes[nholes++].id = e->e_id;
438 } else if ( !hole ) {
443 for ( i=0; i<nholes; i++) {
444 if ( holes[i].id == e->e_id ) {
445 free(holes[i].dn.bv_val);
446 for (j=i;j<nholes;j++) holes[j] = holes[j+1];
450 } else if ( holes[i].id > e->e_id ) {
464 struct mdb_info *mdb = (struct mdb_info *) op->o_bd->be_private;
466 if ( !mdb->mi_nattrs )
470 if ( slapMode & SLAP_TOOL_QUICK ) {
475 ir = mdb_tool_index_rec;
476 memset(ir, 0, mdb->bi_nattrs * sizeof( IndexRec ));
478 for ( a = e->e_attrs; a != NULL; a = a->a_next ) {
479 rc = mdb_index_recset( mdb, a, a->a_desc->ad_type,
480 &a->a_desc->ad_tags, ir );
484 mdb_tool_ix_id = e->e_id;
486 ldap_pvt_thread_mutex_lock( &mdb_tool_index_mutex );
487 /* Wait for all threads to be ready */
488 while ( mdb_tool_index_tcount ) {
489 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_main,
490 &mdb_tool_index_mutex );
492 for ( i=1; i<slap_tool_thread_max; i++ )
493 mdb_tool_index_threads[i] = LDAP_BUSY;
494 mdb_tool_index_tcount = slap_tool_thread_max - 1;
495 ldap_pvt_thread_cond_broadcast( &mdb_tool_index_cond_work );
496 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
497 rc = mdb_index_recrun( op, mdb, ir, e->e_id, 0 );
500 ldap_pvt_thread_mutex_lock( &mdb_tool_index_mutex );
501 for ( i=1; i<slap_tool_thread_max; i++ ) {
502 if ( mdb_tool_index_threads[i] == LDAP_BUSY ) {
503 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_main,
504 &mdb_tool_index_mutex );
508 if ( mdb_tool_index_threads[i] ) {
509 rc = mdb_tool_index_threads[i];
513 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
518 return mdb_index_entry_add( op, txn, e );
522 ID mdb_tool_entry_put(
525 struct berval *text )
528 struct mdb_info *mdb;
532 assert( be != NULL );
533 assert( slapMode & SLAP_TOOL_MODE );
535 assert( text != NULL );
536 assert( text->bv_val != NULL );
537 assert( text->bv_val[0] == '\0' ); /* overconservative? */
539 Debug( LDAP_DEBUG_TRACE, "=> " LDAP_XSTRING(mdb_tool_entry_put)
540 "( %ld, \"%s\" )\n", (long) e->e_id, e->e_dn, 0 );
542 mdb = (struct mdb_info *) be->be_private;
545 rc = mdb_txn_begin( mdb->mi_dbenv, 0, &txn );
547 snprintf( text->bv_val, text->bv_len,
548 "txn_begin failed: %s (%d)",
549 mdb_strerror(rc), rc );
550 Debug( LDAP_DEBUG_ANY,
551 "=> " LDAP_XSTRING(mdb_tool_entry_put) ": %s\n",
552 text->bv_val, 0, 0 );
559 op.o_tmpmemctx = NULL;
560 op.o_tmpmfuncs = &ch_mfuncs;
562 /* add dn2id indices */
563 rc = mdb_tool_next_id( &op, txn, e, text, 0 );
568 rc = mdb_tool_index_add( &op, txn, e );
570 snprintf( text->bv_val, text->bv_len,
571 "index_entry_add failed: %s (%d)",
572 rc == LDAP_OTHER ? "Internal error" :
573 mdb_strerror(rc), rc );
574 Debug( LDAP_DEBUG_ANY,
575 "=> " LDAP_XSTRING(mdb_tool_entry_put) ": %s\n",
576 text->bv_val, 0, 0 );
582 rc = mdb_id2entry_add( &op, txn, e );
584 snprintf( text->bv_val, text->bv_len,
585 "id2entry_add failed: %s (%d)",
586 mdb_strerror(rc), 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! %s (%d)\n",
751 mdb_strerror(rc), rc, 0 );
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_add failed: %s (%d)",
811 mdb_strerror(rc), rc );
812 Debug( LDAP_DEBUG_ANY,
813 "=> " LDAP_XSTRING(mdb_tool_entry_modify) ": %s\n",
814 text->bv_val, 0, 0 );
820 rc = mdb_txn_commit( tid );
822 snprintf( text->bv_val, text->bv_len,
823 "txn_commit failed: %s (%d)",
824 mdb_strerror(rc), rc );
825 Debug( LDAP_DEBUG_ANY,
826 "=> " LDAP_XSTRING(mdb_tool_entry_modify) ": "
827 "%s\n", text->bv_val, 0, 0 );
832 mdb_txn_abort( tid );
833 snprintf( text->bv_val, text->bv_len,
834 "txn_aborted! %s (%d)",
835 mdb_strerror(rc), rc );
836 Debug( LDAP_DEBUG_ANY,
837 "=> " LDAP_XSTRING(mdb_tool_entry_modify) ": %s\n",
838 text->bv_val, 0, 0 );
847 mdb_tool_index_task( void *ctx, void *ptr )
849 int base = *(int *)ptr;
853 ldap_pvt_thread_mutex_lock( &mdb_tool_index_mutex );
854 mdb_tool_index_tcount--;
855 if ( !mdb_tool_index_tcount )
856 ldap_pvt_thread_cond_signal( &mdb_tool_index_cond_main );
857 ldap_pvt_thread_cond_wait( &mdb_tool_index_cond_work,
858 &mdb_tool_index_mutex );
859 if ( slapd_shutdown ) {
860 mdb_tool_index_tcount--;
861 if ( !mdb_tool_index_tcount )
862 ldap_pvt_thread_cond_signal( &mdb_tool_index_cond_main );
863 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
866 ldap_pvt_thread_mutex_unlock( &mdb_tool_index_mutex );
868 mdb_tool_index_threads[base] = mdb_index_recrun( mdb_tool_ix_op,
869 mdb_tool_info, mdb_tool_index_rec, mdb_tool_ix_id, base );