1 /* ldbm.c - ldap dbm compatibility routines */
4 * Copyright 1998-2002 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
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"
28 ldbm_datum_free( LDBM ldbm, Datum data )
32 memset( &data, '\0', sizeof( Datum ));
38 ldbm_datum_dup( LDBM ldbm, Datum data )
42 ldbm_datum_init( dup );
44 if ( data.dsize == 0 ) {
50 dup.dsize = data.dsize;
52 if ( (dup.dptr = (char *) malloc( data.dsize )) != NULL ) {
53 AC_MEMCPY( dup.dptr, data.dptr, data.dsize );
59 static int ldbm_initialized = 0;
61 #if defined( USE_BERKELEY_CDB )
62 /* not currently supported */
63 #define LDBM_RWLOCK_INIT ((void) 0)
64 #define LDBM_RWLOCK_DESTROY ((void) 0)
65 #define LDBM_WLOCK ((void) 0)
66 #define LDBM_WUNLOCK ((void) 0)
67 #define LDBM_RLOCK ((void) 0)
68 #define LDBM_RUNLOCK ((void) 0)
70 #elif defined( HAVE_BERKELEY_DB_THREAD )
71 static ldap_pvt_thread_rdwr_t ldbm_big_rdwr;
72 #define LDBM_RWLOCK_INIT (ldap_pvt_thread_rdwr_init( &ldbm_big_rdwr ))
73 #define LDBM_RWLOCK_DESTROY (ldap_pvt_thread_rdwr_destroy( &ldbm_big_rdwr ))
74 #define LDBM_WLOCK (ldap_pvt_thread_rdwr_wlock(&ldbm_big_rdwr))
75 #define LDBM_WUNLOCK (ldap_pvt_thread_rdwr_wunlock(&ldbm_big_rdwr))
76 #define LDBM_RLOCK (ldap_pvt_thread_rdwr_rlock(&ldbm_big_rdwr))
77 #define LDBM_RUNLOCK (ldap_pvt_thread_rdwr_runlock(&ldbm_big_rdwr))
80 static ldap_pvt_thread_mutex_t ldbm_big_mutex;
81 #define LDBM_RWLOCK_INIT (ldap_pvt_thread_mutex_init( &ldbm_big_mutex ))
82 #define LDBM_RWLOCK_DESTROY (ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex ))
83 #define LDBM_WLOCK (ldap_pvt_thread_mutex_lock(&ldbm_big_mutex))
84 #define LDBM_WUNLOCK (ldap_pvt_thread_mutex_unlock(&ldbm_big_mutex))
85 #define LDBM_RLOCK LDBM_WLOCK
86 #define LDBM_RUNLOCK LDBM_WUNLOCK
89 #if !defined( HAVE_BERKELEY_DB ) || (DB_VERSION_MAJOR < 3)
90 /* a dbEnv for BERKELEYv2 */
91 DB_ENV *ldbm_Env = NULL; /* real or fake, depending on db and version */
94 /*******************************************************************
96 * Create some special functions to initialize Berkeley DB for *
97 * versions greater than 2. *
99 *******************************************************************/
100 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
103 ldbm_malloc( size_t size )
105 /* likely should use ber_mem* routines */
106 return( calloc( 1, size ) );
110 #include <ac/syslog.h>
114 ldbm_db_errcall( const char *prefix, char *message )
117 syslog( LOG_INFO, "ldbm: %s %s", prefix, message );
121 int ldbm_initialize( const char* home )
123 #if DB_VERSION_MAJOR < 3
128 if(ldbm_initialized++) return 1;
132 int major, minor, patch;
133 version = db_version( &major, &minor, &patch );
135 if( major != DB_VERSION_MAJOR ||
136 minor < DB_VERSION_MINOR )
140 "ldbm_initialize(): version mismatch\nexpected: %s\ngot: %s\n",
141 DB_VERSION_STRING, version );
147 #if DB_VERSION_MAJOR < 3
148 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
150 if( ldbm_Env == NULL ) return 1;
152 ldbm_Env->db_errcall = ldbm_db_errcall;
153 ldbm_Env->db_errpfx = "==>";
155 envFlags = DB_CREATE | DB_USE_ENVIRON;
157 /* add optional flags */
159 envFlags |= DB_PRIVATE;
161 #ifdef HAVE_BERKELEY_DB_THREAD
162 envFlags |= DB_THREAD;
165 err = db_appinit( home, NULL, ldbm_Env, envFlags );
169 syslog( LOG_INFO, "ldbm_initialize(): "
170 "FATAL error (%d) in db_appinit()\n", err );
181 int ldbm_shutdown( void )
183 if( !ldbm_initialized ) return 1;
185 #if DB_VERSION_MAJOR < 3
186 db_appexit( ldbm_Env );
193 #else /* some DB other than Berkeley V2 or greater */
195 int ldbm_initialize( const char * home )
197 if(ldbm_initialized++) return 1;
204 int ldbm_shutdown( void )
206 if( !ldbm_initialized ) return 1;
213 #endif /* HAVE_BERKELEY_DB */
215 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 3)
217 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
223 err = db_env_create( &env, 0 );
227 syslog( LOG_INFO, "ldbm_initialize_env(): "
228 "FATAL error in db_env_create() : %s (%d)\n",
229 db_strerror( err ), err );
234 #if DB_VERSION_MAJOR > 3 || DB_VERSION_MINOR >= 3
235 /* This interface appeared in 3.3 */
236 env->set_alloc( env, ldbm_malloc, NULL, NULL );
239 env->set_errcall( env, ldbm_db_errcall );
240 env->set_errpfx( env, "==>" );
242 env->set_cachesize( env, 0, dbcachesize, 0 );
245 envFlags = DB_CREATE | DB_INIT_MPOOL | DB_USE_ENVIRON;
247 envFlags |= DB_PRIVATE;
249 #ifdef DB_MPOOL_PRIVATE
250 envFlags |= DB_MPOOL_PRIVATE;
252 #ifdef HAVE_BERKELEY_DB_THREAD
253 envFlags |= DB_THREAD;
256 #if DB_VERSION_MAJOR > 3 || DB_VERSION_MINOR > 0
257 err = env->open( env, home, envFlags, 0 );
259 /* 3.0.x requires an extra argument */
260 err = env->open( env, home, NULL, envFlags, 0 );
265 syslog( LOG_INFO, "ldbm_initialize_env(): "
266 "FATAL error in dbEnv->open() : %s (%d)\n",
267 db_strerror( err ), err );
269 env->close( env, 0 );
277 void ldbm_shutdown_env(DB_ENV *env)
279 env->close( env, 0 );
284 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
289 void ldbm_shutdown_env(DB_ENV *env)
295 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
297 /*****************************************************************
299 * use berkeley db hash or btree package *
301 *****************************************************************/
304 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
308 #if DB_VERSION_MAJOR >= 3
313 err = db_create( &ret, env, 0 );
315 (void)ret->close(ret, 0);
321 #if DB_VERSION_MAJOR == 3 && DB_VERSION_MINOR < 3
322 ret->set_malloc( ret, ldbm_malloc );
325 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
327 /* likely should use ber_mem* routines */
329 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
333 (void)ret->close(ret, 0);
342 #elif DB_VERSION_MAJOR >= 2
345 memset( &dbinfo, '\0', sizeof( dbinfo ));
347 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
349 * BerkeleyDB 2.4 do not allow db_cachesize
350 * to be specified if an DB_ENV is.
353 /* set db_cachesize of MPOOL is NOT being used. */
354 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
355 dbinfo.db_cachesize = dbcachesize;
359 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
360 dbinfo.db_malloc = ldbm_malloc;
363 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
371 if ( DB_TYPE == DB_HASH ) {
372 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
373 hinfo.cachesize = dbcachesize;
375 } else if ( DB_TYPE == DB_BTREE ) {
376 memset( (char *) &binfo, '\0', sizeof(binfo) );
377 binfo.cachesize = dbcachesize;
384 ret = dbopen( name, rw, mode, DB_TYPE, info );
392 ldbm_close( LDBM ldbm )
395 #if DB_VERSION_MAJOR >= 2
396 ldbm->close( ldbm, 0 );
404 ldbm_sync( LDBM ldbm )
407 (*ldbm->sync)( ldbm, 0 );
412 ldbm_fetch( LDBM ldbm, Datum key )
419 #if DB_VERSION_MAJOR >= 2
420 ldbm_datum_init( data );
422 data.flags = DB_DBT_MALLOC;
424 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
425 ldbm_datum_free( ldbm, data );
430 if ( (rc = ldbm->get( ldbm, &key, &data, 0 )) == 0 ) {
431 /* Berkeley DB 1.85 don't malloc the data for us */
432 /* duplicate it for to ensure reentrancy */
433 data = ldbm_datum_dup( ldbm, data );
446 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
452 #if DB_VERSION_MAJOR >= 2
453 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
456 rc = ldbm->put( ldbm, &key, &data, flags & ~LDBM_SYNC );
459 if ( flags & LDBM_SYNC )
460 ldbm->sync( ldbm, 0 );
468 ldbm_delete( LDBM ldbm, Datum key )
474 #if DB_VERSION_MAJOR >= 2
475 rc = ldbm->del( ldbm, NULL, &key, 0 );
478 rc = ldbm->del( ldbm, &key, 0 );
480 ldbm->sync( ldbm, 0 );
488 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
493 #if DB_VERSION_MAJOR >= 2
496 ldbm_datum_init( key );
497 ldbm_datum_init( data );
499 key.flags = data.flags = DB_DBT_MALLOC;
503 /* acquire a cursor for the DB */
504 # if DB_VERSION_MAJOR >= 3 || (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR > 5)
505 rc = ldbm->cursor( ldbm, NULL, &dbci, 0 );
507 rc = ldbm->cursor( ldbm, NULL, &dbci );
514 if ( dbci->c_get( dbci, &key, &data, DB_NEXT ) == 0 ) {
515 ldbm_datum_free( ldbm, data );
527 rc = ldbm->seq( ldbm, &key, &data, R_FIRST );
530 key = ldbm_datum_dup( ldbm, key );
543 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
550 #if DB_VERSION_MAJOR >= 2
551 ldbm_datum_init( data );
553 ldbm_datum_free( ldbm, key );
554 key.flags = data.flags = DB_DBT_MALLOC;
556 rc = dbcp->c_get( dbcp, &key, &data, DB_NEXT );
558 ldbm_datum_free( ldbm, data );
561 rc = ldbm->seq( ldbm, &key, &data, R_NEXT );
564 key = ldbm_datum_dup( ldbm, key );
577 ldbm_errno( LDBM ldbm )
582 /******************************************************************
584 * END Berkeley section *
586 ******************************************************************/
588 #elif defined( HAVE_GDBM )
590 #ifdef HAVE_ST_BLKSIZE
591 #include <sys/stat.h>
594 /*****************************************************************
598 *****************************************************************/
601 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
604 #ifdef HAVE_ST_BLKSIZE
610 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
615 #ifdef HAVE_ST_BLKSIZE
616 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
617 dbcachesize /= st.st_blksize;
618 if( dbcachesize == 0 ) dbcachesize = 1;
619 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
622 if ( dbcachesize > 0 ) {
624 if( dbcachesize == 0 ) dbcachesize = 1;
625 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
635 ldbm_close( LDBM ldbm )
643 ldbm_sync( LDBM ldbm )
651 ldbm_fetch( LDBM ldbm, Datum key )
656 d = gdbm_fetch( ldbm, key );
663 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
668 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
669 if ( flags & LDBM_SYNC )
677 ldbm_delete( LDBM ldbm, Datum key )
682 rc = gdbm_delete( ldbm, key );
690 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
695 d = gdbm_firstkey( ldbm );
698 if ( d.dptr != NULL ) {
699 *dbcp = (Datum *) malloc( sizeof( Datum ) );
700 **dbcp = ldbm_datum_dup( ldbm, d );
707 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
712 d = gdbm_nextkey( ldbm, *dbcp );
715 ldbm_datum_free( ldbm, *dbcp );
717 if ( d.dptr != NULL ) {
718 *dbcp = ldbm_datum_dup( ldbm, d );
727 ldbm_errno( LDBM ldbm )
740 /* MMAPED DBM HASHING DATABASE */
742 #include <ac/string.h>
744 /* #define MDBM_DEBUG */
751 /* #define MDBM_CHAIN */
757 #define mdbm_store mdbm_chain_store
758 #define mdbm_fetch mdbm_chain_fetch
759 #define mdbm_delete mdbm_chain_delete
760 #define mdbm_first mdbm_chain_first
761 #define mdbm_next mdbm_chain_next
765 #define MDBM_PG_SZ (4*1024)
767 /*****************************************************************
771 *****************************************************************/
774 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
780 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
781 name ? name : "NULL", rw, mode, dbcachesize );
785 LDBM_WLOCK; /* We need locking here, this is the only non-thread
786 * safe function we have. */
788 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
791 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
798 (void)mdbm_set_chain(db);
804 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
812 ldbm_close( LDBM ldbm )
814 /* Open and close are not reentrant so we need to use locks here */
818 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
827 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
833 ldbm_sync( LDBM ldbm )
835 /* XXX: Not sure if this is re-entrant need to check code, if so
836 * you can leave LOCKS out.
844 #define MAX_MDBM_RETRY 5
847 ldbm_fetch( LDBM ldbm, Datum key )
853 /* This hack is needed because MDBM does not take keys
854 * which begin with NULL when working in the chaining
859 k.key.dsize = key.dsize + 1;
860 k.key.dptr = malloc(k.key.dsize);
862 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
872 d = mdbm_fetch( ldbm, k );
875 if ( k.val.dptr != NULL ) {
879 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
880 k.val.dsize = d.dsize;
881 d = mdbm_fetch( ldbm, k );
887 }/* if ( d.dsize > 0 ) */
888 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
899 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
902 Datum int_key; /* Internal key */
906 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
907 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
914 int_key.dsize = key.dsize + 1;
915 int_key.dptr = malloc( int_key.dsize );
916 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
917 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
922 rc = mdbm_store( ldbm, int_key, data, flags );
923 if ( flags & LDBM_SYNC ) {
930 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
942 ldbm_delete( LDBM ldbm, Datum key )
950 int_key.dsize = key.dsize + 1;
951 int_key.dptr = malloc(int_key.dsize);
952 *(int_key.dptr) = 'l';
953 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
958 rc = mdbm_delete( ldbm, int_key );
969 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
974 size_t sz = MDBM_PAGE_SIZE(ldbm);
983 in.key.dsize = sz; /* Assume first key in one pg */
984 in.key.dptr = malloc(sz);
986 in.val.dptr = NULL; /* Don't need data just key */
992 out = fptr( ldbm, in );
994 if (out.key.dsize > 0) {
995 ret.dsize = out.key.dsize - delta;
997 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1002 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1014 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1016 return ldbm_get_next( ldbm, mdbm_first );
1020 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1023 * don't know if this will affect the LDAP server operation
1024 * but mdbm cannot take and input key.
1027 return ldbm_get_next( ldbm, mdbm_next );
1031 ldbm_errno( LDBM ldbm )
1033 /* XXX: best we can do with current mdbm interface */
1037 #elif defined( HAVE_NDBM )
1039 /*****************************************************************
1041 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1043 *****************************************************************/
1047 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
1052 ldbm = dbm_open( name, rw, mode );
1059 ldbm_close( LDBM ldbm )
1068 ldbm_sync( LDBM ldbm )
1074 ldbm_fetch( LDBM ldbm, Datum key )
1079 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1086 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1091 rc = dbm_store( ldbm, key, data, flags );
1098 ldbm_delete( LDBM ldbm, Datum key )
1103 rc = dbm_delete( ldbm, key );
1110 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1115 d = dbm_firstkey( ldbm );
1122 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1127 d = dbm_nextkey( ldbm );
1134 ldbm_errno( LDBM ldbm )
1139 err = dbm_error( ldbm );