1 /* ldbm.c - ldap dbm compatibility routines */
3 * Copyright 1998-1999 The OpenLDAP Foundation, All Rights Reserved.
4 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
7 /* Patched for Berkeley DB version 2.0; /KSp; 98/02/23
9 * - DB version 2.6.4b ; 1998/12/28, /KSp
10 * - DB_DBT_MALLOC ; 1998/03/22, /KSp
11 * - basic implementation; 1998/02/23, /KSp
20 #include <ac/stdlib.h>
21 #include <ac/string.h>
25 #include "ldap_pvt_thread.h"
29 ldbm_datum_free( LDBM ldbm, Datum data )
33 memset( &data, 0, sizeof( Datum ));
40 ldbm_datum_dup( LDBM ldbm, Datum data )
44 ldbm_datum_init( dup );
46 if ( data.dsize == 0 ) {
52 dup.dsize = data.dsize;
53 if ( (dup.dptr = (char *) malloc( data.dsize )) != NULL )
54 memcpy( dup.dptr, data.dptr, data.dsize );
59 static int ldbm_initialized = 0;
61 #ifndef HAVE_BERKELEY_DB2
62 /* Everything but DB2 is non-reentrant */
64 static ldap_pvt_thread_mutex_t ldbm_big_mutex;
65 #define LDBM_LOCK (ldap_pvt_thread_mutex_lock(&ldbm_big_mutex))
66 #define LDBM_UNLOCK (ldap_pvt_thread_mutex_unlock(&ldbm_big_mutex))
68 int ldbm_initialize( void )
70 if(ldbm_initialized++) return 1;
72 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
77 int ldbm_shutdown( void )
79 if( !ldbm_initialized ) return 1;
81 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
89 ldbm_malloc( size_t size )
91 return( calloc( 1, size ));
95 #include <ac/syslog.h>
99 ldbm_db_errcall( const char *prefix, char *message )
102 syslog( LOG_INFO, "ldbm_db_errcall(): %s %s", prefix, message );
106 /* a dbEnv for BERKELEYv2 */
107 static DB_ENV ldbm_Env_internal;
108 DB_ENV *ldbm_Env = NULL;
110 /* Berkeley DB 2.x is reentrant */
111 #define LDBM_LOCK ((void)0)
112 #define LDBM_UNLOCK ((void)0)
114 int ldbm_initialize( void )
119 if(ldbm_initialized++) return 1;
121 memset( &ldbm_Env_internal, 0, sizeof( DB_ENV ));
122 ldbm_Env = &ldbm_Env_internal;
124 ldbm_Env->db_errcall = ldbm_db_errcall;
125 ldbm_Env->db_errpfx = "==>";
127 envFlags = DB_CREATE | DB_THREAD;
129 if ( ( err = db_appinit( NULL, NULL, ldbm_Env, envFlags )) ) {
133 sprintf( error, "%ld\n", (long) err );
135 sprintf( error, "%s\n", strerror( err ));
140 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
149 int ldbm_shutdown( void )
151 if( !ldbm_initialized ) return 1;
153 db_appexit( ldbm_Env );
160 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
162 /*****************************************************************
164 * use berkeley db hash or btree package *
166 *****************************************************************/
169 ldbm_open( char *name, int rw, int mode, int dbcachesize )
173 #ifdef HAVE_BERKELEY_DB2
176 memset( &dbinfo, 0, sizeof( dbinfo ));
178 #if defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
179 DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
181 * BerkeleyDB 2.4 do not allow db_cachesize
182 * to be specified if an DB_ENV is.
185 /* set db_cachesize of MPOOL is NOT being used. */
186 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL ))
187 dbinfo.db_cachesize = dbcachesize;
190 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
191 dbinfo.db_malloc = ldbm_malloc;
194 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
202 if ( DB_TYPE == DB_HASH ) {
203 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
204 hinfo.cachesize = dbcachesize;
206 } else if ( DB_TYPE == DB_BTREE ) {
207 memset( (char *) &binfo, '\0', sizeof(binfo) );
208 binfo.cachesize = dbcachesize;
215 ret = dbopen( name, rw, mode, DB_TYPE, info );
224 ldbm_close( LDBM ldbm )
227 #ifdef HAVE_BERKELEY_DB2
228 (*ldbm->close)( ldbm, 0 );
230 (*ldbm->close)( ldbm );
236 ldbm_sync( LDBM ldbm )
239 (*ldbm->sync)( ldbm, 0 );
244 ldbm_fetch( LDBM ldbm, Datum key )
251 #ifdef HAVE_BERKELEY_DB2
252 ldbm_datum_init( data );
254 data.flags = DB_DBT_MALLOC;
256 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
257 ldbm_datum_free( ldbm, data );
259 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
260 /* Berkeley DB 1.85 don't malloc the data for us */
261 /* duplicate it for to ensure reentrancy */
262 data = ldbm_datum_dup( ldbm, data );
275 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
281 #ifdef HAVE_BERKELEY_DB2
282 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
285 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
288 if ( flags & LDBM_SYNC )
289 (*ldbm->sync)( ldbm, 0 );
297 ldbm_delete( LDBM ldbm, Datum key )
303 #ifdef HAVE_BERKELEY_DB2
304 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
307 rc = (*ldbm->del)( ldbm, &key, 0 );
309 (*ldbm->sync)( ldbm, 0 );
317 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
321 #ifdef HAVE_BERKELEY_DB2
324 ldbm_datum_init( key );
325 ldbm_datum_init( data );
327 key.flags = data.flags = DB_DBT_MALLOC;
331 /* acquire a cursor for the DB */
333 # if defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
334 DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6
336 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
339 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
346 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
347 ldbm_datum_free( ldbm, data );
355 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
356 key = ldbm_datum_dup( ldbm, key );
364 #ifdef HAVE_BERKELEY_DB2
374 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
378 #ifdef HAVE_BERKELEY_DB2
379 ldbm_datum_init( data );
381 ldbm_datum_free( ldbm, key );
382 key.flags = data.flags = DB_DBT_MALLOC;
386 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
387 ldbm_datum_free( ldbm, data );
395 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
396 key = ldbm_datum_dup( ldbm, key );
410 ldbm_errno( LDBM ldbm )
415 #elif defined( HAVE_GDBM )
417 #ifdef HAVE_ST_BLKSIZE
418 #include <sys/stat.h>
421 /*****************************************************************
425 *****************************************************************/
428 ldbm_open( char *name, int rw, int mode, int dbcachesize )
431 #ifdef HAVE_ST_BLKSIZE
437 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
442 #ifdef HAVE_ST_BLKSIZE
443 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
444 dbcachesize /= st.st_blksize;
445 if( dbcachesize == 0 ) dbcachesize = 1;
446 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
449 if ( dbcachesize > 0 ) {
451 if( dbcachesize == 0 ) dbcachesize = 1;
452 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
462 ldbm_close( LDBM ldbm )
470 ldbm_sync( LDBM ldbm )
478 ldbm_fetch( LDBM ldbm, Datum key )
483 d = gdbm_fetch( ldbm, key );
490 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
495 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
496 if ( flags & LDBM_SYNC )
504 ldbm_delete( LDBM ldbm, Datum key )
509 rc = gdbm_delete( ldbm, key );
517 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
522 d = gdbm_firstkey( ldbm );
529 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
534 d = gdbm_nextkey( ldbm, key );
541 ldbm_errno( LDBM ldbm )
554 /* MMAPED DBM HASHING DATABASE */
556 #include <ac/string.h>
558 /* #define MDBM_DEBUG */
565 /* #define MDBM_CHAIN */
572 #define mdbm_store mdbm_chain_store
573 #define mdbm_fetch mdbm_chain_fetch
574 #define mdbm_delete mdbm_chain_delete
575 #define mdbm_first mdbm_chain_first
576 #define mdbm_next mdbm_chain_next
580 #define MDBM_PG_SZ (4*1024)
582 /*****************************************************************
586 *****************************************************************/
589 ldbm_open( char *name, int rw, int mode, int dbcachesize )
595 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
596 name ? name : "NULL", rw, mode, dbcachesize );
600 LDBM_LOCK; /* We need locking here, this is the only non-thread
601 * safe function we have.
604 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
608 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
616 (void)mdbm_set_chain(db);
622 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
634 ldbm_close( LDBM ldbm )
637 /* Open and close are not reentrant so we need to use locks here */
641 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
650 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
660 ldbm_sync( LDBM ldbm )
663 /* XXX: Not sure if this is re-entrant need to check code, if so
664 * you can leave LOCKS out.
674 #define MAX_MDBM_RETRY 5
677 ldbm_fetch( LDBM ldbm, Datum key )
683 /* This hack is needed because MDBM does not take keys
684 * which begin with NULL when working in the chaining
691 k.key.dsize = key.dsize + 1;
692 k.key.dptr = malloc(k.key.dsize);
694 memcpy( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
704 d = mdbm_fetch( ldbm, k );
708 if ( k.val.dptr != NULL ) {
714 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
716 k.val.dsize = d.dsize;
717 d = mdbm_fetch( ldbm, k );
726 }/* if ( d.dsize > 0 ) */
728 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
744 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
747 Datum int_key; /* Internal key */
751 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
752 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
759 int_key.dsize = key.dsize + 1;
760 int_key.dptr = malloc( int_key.dsize );
761 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
762 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
767 rc = mdbm_store( ldbm, int_key, data, flags );
768 if ( flags & LDBM_SYNC ) {
775 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
790 ldbm_delete( LDBM ldbm, Datum key )
798 int_key.dsize = key.dsize + 1;
799 int_key.dptr = malloc(int_key.dsize);
800 *(int_key.dptr) = 'l';
801 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
806 rc = mdbm_delete( ldbm, int_key );
821 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
827 size_t sz = MDBM_PAGE_SIZE(ldbm);
836 in.key.dsize = sz; /* Assume first key in one pg */
837 in.key.dptr = malloc(sz);
839 in.val.dptr = NULL; /* Don't need data just key */
845 out = fptr( ldbm, in );
847 if (out.key.dsize > 0) {
849 ret.dsize = out.key.dsize - delta;
850 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
857 memcpy(ret.dptr, (void *)(out.key.dptr + delta),
876 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
879 return ldbm_get_next( ldbm, mdbm_first );
887 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
891 * don't know if this will affect the LDAP server opertaion
892 * but mdbm cannot take and input key.
895 return ldbm_get_next( ldbm, mdbm_next );
900 ldbm_errno( LDBM ldbm )
902 /* XXX: best we can do with current mdbm interface */
910 #elif defined( HAVE_NDBM )
912 /*****************************************************************
914 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
916 *****************************************************************/
920 ldbm_open( char *name, int rw, int mode, int dbcachesize )
925 ldbm = dbm_open( name, rw, mode );
932 ldbm_close( LDBM ldbm )
941 ldbm_sync( LDBM ldbm )
947 ldbm_fetch( LDBM ldbm, Datum key )
952 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
959 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
964 rc = dbm_store( ldbm, key, data, flags );
971 ldbm_delete( LDBM ldbm, Datum key )
976 rc = dbm_delete( ldbm, key );
983 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
988 d = dbm_firstkey( ldbm );
995 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1000 d = dbm_nextkey( ldbm );
1007 ldbm_errno( LDBM ldbm )
1012 err = dbm_error( ldbm );