1 /* ldbm.c - ldap dbm compatibility routines */
4 * Copyright 1998-2000 The OpenLDAP Foundation, All Rights Reserved.
5 * COPYING RESTRICTIONS APPLY, see COPYRIGHT file
8 /* Patched for Berkeley DB version 2.0; /KSp; 98/02/23
10 * - DB version 2.6.4b ; 1998/12/28, /KSp
11 * - DB_DBT_MALLOC ; 1998/03/22, /KSp
12 * - basic implementation; 1998/02/23, /KSp
21 #include <ac/stdlib.h>
22 #include <ac/string.h>
26 #include "ldap_pvt_thread.h"
29 ldbm_datum_free( LDBM ldbm, Datum data )
33 memset( &data, '\0', sizeof( Datum ));
39 ldbm_datum_dup( LDBM ldbm, Datum data )
43 ldbm_datum_init( dup );
45 if ( data.dsize == 0 ) {
51 dup.dsize = data.dsize;
53 if ( (dup.dptr = (char *) malloc( data.dsize )) != NULL ) {
54 AC_MEMCPY( dup.dptr, data.dptr, data.dsize );
60 static int ldbm_initialized = 0;
62 #ifdef USE_BERKELEY_CDB
63 /* not currently supported */
64 #define LDBM_LOCK ((void) 0)
65 #define LDBM_UNLOCK ((void) 0)
67 static ldap_pvt_thread_mutex_t ldbm_big_mutex;
68 #define LDBM_LOCK (ldap_pvt_thread_mutex_lock(&ldbm_big_mutex))
69 #define LDBM_UNLOCK (ldap_pvt_thread_mutex_unlock(&ldbm_big_mutex))
72 #if !defined( HAVE_BERKELEY_DB ) || (DB_VERSION_MAJOR < 3)
73 /* a dbEnv for BERKELEYv2 */
74 DB_ENV *ldbm_Env = NULL; /* real or fake, depending on db and version */
78 /*******************************************************************
80 * Create some special functions to initialize Berkeley DB for *
81 * versions greater than 2. *
83 *******************************************************************/
84 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
87 ldbm_malloc( size_t size )
89 /* likely should use ber_mem* routines */
90 return( calloc( 1, size ) );
94 #include <ac/syslog.h>
98 ldbm_db_errcall( const char *prefix, char *message )
101 syslog( LOG_INFO, "ldbm: %s %s", prefix, message );
105 int ldbm_initialize( const char* home )
110 if(ldbm_initialized++) return 1;
114 int major, minor, patch;
115 version = db_version( &major, &minor, &patch );
117 if( major != DB_VERSION_MAJOR ||
118 minor < DB_VERSION_MINOR )
122 "ldbm_initialize(): version mismatch\nexpected: %s\ngot: %s\n",
123 DB_VERSION_STRING, version );
129 #ifndef USE_BERKELEY_CDB
130 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
134 #if DB_VERSION_MAJOR < 3
135 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
137 if( ldbm_Env == NULL ) return 1;
139 ldbm_Env->db_errcall = ldbm_db_errcall;
140 ldbm_Env->db_errpfx = "==>";
142 envFlags = DB_CREATE | DB_USE_ENVIRON;
144 /* add optional flags */
146 envFlags |= DB_PRIVATE;
148 #ifdef HAVE_BERKELEY_DB_THREAD
149 envFlags |= DB_THREAD;
152 err = db_appinit( home, NULL, ldbm_Env, envFlags );
156 syslog( LOG_INFO, "ldbm_initialize(): "
157 "FATAL error in db_appinit() : %s (%d)\n",
158 db_strerror( err ), err );
167 int ldbm_shutdown( void )
169 if( !ldbm_initialized ) return 1;
171 #if DB_VERSION_MAJOR < 3
172 db_appexit( ldbm_Env );
175 #ifndef USE_BERKELEY_CDB
176 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
181 #else /* some DB other than Berkeley V2 or greater */
183 int ldbm_initialize( const char * home )
185 if(ldbm_initialized++) return 1;
187 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
192 int ldbm_shutdown( void )
194 if( !ldbm_initialized ) return 1;
196 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
201 #endif /* HAVE_BERKELEY_DB */
204 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 3)
206 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
212 err = db_env_create( &env, 0 );
216 syslog( LOG_INFO, "ldbm_initialize_env(): "
217 "FATAL error in db_env_create() : %s (%d)\n",
218 db_strerror( err ), err );
223 env->set_errcall( env, ldbm_db_errcall );
224 env->set_errpfx( env, "==>" );
226 env->set_cachesize( env, 0, dbcachesize, 0 );
229 envFlags = DB_CREATE | DB_INIT_MPOOL | DB_USE_ENVIRON;
231 envFlags |= DB_PRIVATE;
233 #ifdef DB_MPOOL_PRIVATE
234 envFlags |= DB_MPOOL_PRIVATE;
236 #ifdef HAVE_BERKELEY_DB_THREAD
237 envFlags |= DB_THREAD;
240 #if DB_VERSION_MAJOR > 3 || DB_VERSION_MINOR > 0
241 err = env->open( env, home, envFlags, 0 );
243 /* 3.0.x requires an extra argument */
244 err = env->open( env, home, NULL, envFlags, 0 );
249 syslog( LOG_INFO, "ldbm_initialize_env(): "
250 "FATAL error in dbEnv->open() : %s (%d)\n",
251 db_strerror( err ), err );
253 env->close( env, 0 );
261 void ldbm_shutdown_env(DB_ENV *env)
263 env->close( env, 0 );
269 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
274 void ldbm_shutdown_env(DB_ENV *env)
281 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
283 /*****************************************************************
285 * use berkeley db hash or btree package *
287 *****************************************************************/
290 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
294 #if DB_VERSION_MAJOR >= 3
299 err = db_create( &ret, env, 0 );
301 (void)ret->close(ret, 0);
307 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
309 /* likely should use ber_mem* routines */
310 #if DB_VERSION_MINOR >= 3
311 ret->set_alloc( ret, ldbm_malloc, NULL, NULL );
313 ret->set_malloc( ret, ldbm_malloc );
316 /* ret->set_cachesize( ret, 0, dbcachesize, 0 ); */
318 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
322 (void)ret->close(ret, 0);
331 #elif DB_VERSION_MAJOR >= 2
334 memset( &dbinfo, '\0', sizeof( dbinfo ));
336 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
338 * BerkeleyDB 2.4 do not allow db_cachesize
339 * to be specified if an DB_ENV is.
342 /* set db_cachesize of MPOOL is NOT being used. */
343 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
344 dbinfo.db_cachesize = dbcachesize;
348 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
349 dbinfo.db_malloc = ldbm_malloc;
352 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
360 if ( DB_TYPE == DB_HASH ) {
361 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
362 hinfo.cachesize = dbcachesize;
364 } else if ( DB_TYPE == DB_BTREE ) {
365 memset( (char *) &binfo, '\0', sizeof(binfo) );
366 binfo.cachesize = dbcachesize;
373 ret = dbopen( name, rw, mode, DB_TYPE, info );
381 ldbm_close( LDBM ldbm )
384 #if DB_VERSION_MAJOR >= 3
385 ldbm->close( ldbm, 0 );
386 #elif DB_VERSION_MAJOR >= 2
387 (*ldbm->close)( ldbm, 0 );
389 (*ldbm->close)( ldbm );
395 ldbm_sync( LDBM ldbm )
398 (*ldbm->sync)( ldbm, 0 );
403 ldbm_fetch( LDBM ldbm, Datum key )
410 #if DB_VERSION_MAJOR >= 3
411 ldbm_datum_init( data );
413 data.flags = DB_DBT_MALLOC;
415 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
416 ldbm_datum_free( ldbm, data );
421 #elif DB_VERSION_MAJOR >= 2
422 ldbm_datum_init( data );
424 data.flags = DB_DBT_MALLOC;
426 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
427 ldbm_datum_free( ldbm, data );
433 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
434 /* Berkeley DB 1.85 don't malloc the data for us */
435 /* duplicate it for to ensure reentrancy */
436 data = ldbm_datum_dup( ldbm, data );
449 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
455 #if DB_VERSION_MAJOR >= 3
456 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
459 #elif DB_VERSION_MAJOR >= 2
460 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
463 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
466 if ( flags & LDBM_SYNC )
467 (*ldbm->sync)( ldbm, 0 );
475 ldbm_delete( LDBM ldbm, Datum key )
481 #if DB_VERSION_MAJOR >= 3
482 rc = ldbm->del( ldbm, NULL, &key, 0 );
484 #elif DB_VERSION_MAJOR >= 2
485 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
488 rc = (*ldbm->del)( ldbm, &key, 0 );
490 (*ldbm->sync)( ldbm, 0 );
498 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
502 #if DB_VERSION_MAJOR >= 2
505 ldbm_datum_init( key );
506 ldbm_datum_init( data );
508 key.flags = data.flags = DB_DBT_MALLOC;
512 /* acquire a cursor for the DB */
513 # if DB_VERSION_MAJOR >= 3
514 if ( ldbm->cursor( ldbm, NULL, &dbci, 0 ) )
515 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
516 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
518 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
521 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
528 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
529 ldbm_datum_free( ldbm, data );
537 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
538 key = ldbm_datum_dup( ldbm, key );
546 #if DB_VERSION_MAJOR >= 2
556 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
560 #if DB_VERSION_MAJOR >= 2
561 ldbm_datum_init( data );
563 ldbm_datum_free( ldbm, key );
564 key.flags = data.flags = DB_DBT_MALLOC;
568 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
569 ldbm_datum_free( ldbm, data );
577 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
578 key = ldbm_datum_dup( ldbm, key );
592 ldbm_errno( LDBM ldbm )
597 /******************************************************************
599 * END Berkeley section *
601 ******************************************************************/
603 #elif defined( HAVE_GDBM )
605 #ifdef HAVE_ST_BLKSIZE
606 #include <sys/stat.h>
609 /*****************************************************************
613 *****************************************************************/
616 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
619 #ifdef HAVE_ST_BLKSIZE
625 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
630 #ifdef HAVE_ST_BLKSIZE
631 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
632 dbcachesize /= st.st_blksize;
633 if( dbcachesize == 0 ) dbcachesize = 1;
634 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
637 if ( dbcachesize > 0 ) {
639 if( dbcachesize == 0 ) dbcachesize = 1;
640 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
650 ldbm_close( LDBM ldbm )
658 ldbm_sync( LDBM ldbm )
666 ldbm_fetch( LDBM ldbm, Datum key )
671 d = gdbm_fetch( ldbm, key );
678 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
683 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
684 if ( flags & LDBM_SYNC )
692 ldbm_delete( LDBM ldbm, Datum key )
697 rc = gdbm_delete( ldbm, key );
705 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
710 d = gdbm_firstkey( ldbm );
713 if ( d.dptr != NULL ) {
714 *dbcp = (Datum *) malloc( sizeof( Datum ) );
715 **dbcp = ldbm_datum_dup( ldbm, d );
722 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
727 d = gdbm_nextkey( ldbm, *dbcp );
730 ldbm_datum_free( ldbm, *dbcp );
732 if ( d.dptr != NULL ) {
733 *dbcp = ldbm_datum_dup( ldbm, d );
742 ldbm_errno( LDBM ldbm )
755 /* MMAPED DBM HASHING DATABASE */
757 #include <ac/string.h>
759 /* #define MDBM_DEBUG */
766 /* #define MDBM_CHAIN */
773 #define mdbm_store mdbm_chain_store
774 #define mdbm_fetch mdbm_chain_fetch
775 #define mdbm_delete mdbm_chain_delete
776 #define mdbm_first mdbm_chain_first
777 #define mdbm_next mdbm_chain_next
781 #define MDBM_PG_SZ (4*1024)
783 /*****************************************************************
787 *****************************************************************/
790 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
796 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
797 name ? name : "NULL", rw, mode, dbcachesize );
801 LDBM_LOCK; /* We need locking here, this is the only non-thread
802 * safe function we have.
805 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
809 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
817 (void)mdbm_set_chain(db);
823 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
835 ldbm_close( LDBM ldbm )
838 /* Open and close are not reentrant so we need to use locks here */
842 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
851 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
861 ldbm_sync( LDBM ldbm )
863 /* XXX: Not sure if this is re-entrant need to check code, if so
864 * you can leave LOCKS out.
873 #define MAX_MDBM_RETRY 5
876 ldbm_fetch( LDBM ldbm, Datum key )
882 /* This hack is needed because MDBM does not take keys
883 * which begin with NULL when working in the chaining
890 k.key.dsize = key.dsize + 1;
891 k.key.dptr = malloc(k.key.dsize);
893 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
903 d = mdbm_fetch( ldbm, k );
907 if ( k.val.dptr != NULL ) {
911 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
913 k.val.dsize = d.dsize;
914 d = mdbm_fetch( ldbm, k );
923 }/* if ( d.dsize > 0 ) */
925 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
941 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
944 Datum int_key; /* Internal key */
948 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
949 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
956 int_key.dsize = key.dsize + 1;
957 int_key.dptr = malloc( int_key.dsize );
958 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
959 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
964 rc = mdbm_store( ldbm, int_key, data, flags );
965 if ( flags & LDBM_SYNC ) {
972 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
987 ldbm_delete( LDBM ldbm, Datum key )
995 int_key.dsize = key.dsize + 1;
996 int_key.dptr = malloc(int_key.dsize);
997 *(int_key.dptr) = 'l';
998 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
1003 rc = mdbm_delete( ldbm, int_key );
1017 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
1022 size_t sz = MDBM_PAGE_SIZE(ldbm);
1031 in.key.dsize = sz; /* Assume first key in one pg */
1032 in.key.dptr = malloc(sz);
1034 in.val.dptr = NULL; /* Don't need data just key */
1040 out = fptr( ldbm, in );
1042 if (out.key.dsize > 0) {
1043 ret.dsize = out.key.dsize - delta;
1045 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1050 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1062 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1064 return ldbm_get_next( ldbm, mdbm_first );
1068 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1071 * don't know if this will affect the LDAP server operation
1072 * but mdbm cannot take and input key.
1075 return ldbm_get_next( ldbm, mdbm_next );
1079 ldbm_errno( LDBM ldbm )
1081 /* XXX: best we can do with current mdbm interface */
1088 #elif defined( HAVE_NDBM )
1090 /*****************************************************************
1092 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1094 *****************************************************************/
1098 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
1103 ldbm = dbm_open( name, rw, mode );
1110 ldbm_close( LDBM ldbm )
1119 ldbm_sync( LDBM ldbm )
1125 ldbm_fetch( LDBM ldbm, Datum key )
1130 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1137 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1142 rc = dbm_store( ldbm, key, data, flags );
1149 ldbm_delete( LDBM ldbm, Datum key )
1154 rc = dbm_delete( ldbm, key );
1161 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1166 d = dbm_firstkey( ldbm );
1173 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1178 d = dbm_nextkey( ldbm );
1185 ldbm_errno( LDBM ldbm )
1190 err = dbm_error( ldbm );