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 )
311 #if DB_VERSION_MAJOR >= 3
316 err = db_create( &ret, env, 0 );
318 (void)ret->close(ret, 0);
324 #if DB_VERSION_MAJOR == 3 && DB_VERSION_MINOR < 3
325 ret->set_malloc( ret, ldbm_malloc );
328 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
330 /* likely should use ber_mem* routines */
333 strncpy(n2, name, sizeof(n2)-1);
334 n2[sizeof(n2)-1] = '\0';
338 #if DB_VERSION_MAJOR >= 4 && DB_VERSION_MINOR > 0 && DB_VERSION_PATCH >= 17
339 err = ret->open( ret, NULL, name, NULL, DB_TYPE, rw, mode);
341 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
346 (void)ret->close(ret, 0);
355 #elif DB_VERSION_MAJOR >= 2
358 memset( &dbinfo, '\0', sizeof( dbinfo ));
360 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
362 * BerkeleyDB 2.4 do not allow db_cachesize
363 * to be specified if an DB_ENV is.
366 /* set db_cachesize of MPOOL is NOT being used. */
367 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
368 dbinfo.db_cachesize = dbcachesize;
372 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
373 dbinfo.db_malloc = ldbm_malloc;
376 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
384 if ( DB_TYPE == DB_HASH ) {
385 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
386 hinfo.cachesize = dbcachesize;
388 } else if ( DB_TYPE == DB_BTREE ) {
389 memset( (char *) &binfo, '\0', sizeof(binfo) );
390 binfo.cachesize = dbcachesize;
397 ret = dbopen( name, rw, mode, DB_TYPE, info );
405 ldbm_close( LDBM ldbm )
408 #if DB_VERSION_MAJOR >= 2
409 ldbm->close( ldbm, 0 );
417 ldbm_sync( LDBM ldbm )
420 (*ldbm->sync)( ldbm, 0 );
425 ldbm_fetch( LDBM ldbm, Datum key )
432 #if DB_VERSION_MAJOR >= 2
433 ldbm_datum_init( data );
435 data.flags = DB_DBT_MALLOC;
437 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
438 ldbm_datum_free( ldbm, data );
443 if ( (rc = ldbm->get( ldbm, &key, &data, 0 )) == 0 ) {
444 /* Berkeley DB 1.85 don't malloc the data for us */
445 /* duplicate it for to ensure reentrancy */
446 data = ldbm_datum_dup( ldbm, data );
459 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
465 #if DB_VERSION_MAJOR >= 2
466 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
469 rc = ldbm->put( ldbm, &key, &data, flags & ~LDBM_SYNC );
472 if ( flags & LDBM_SYNC )
473 ldbm->sync( ldbm, 0 );
481 ldbm_delete( LDBM ldbm, Datum key )
487 #if DB_VERSION_MAJOR >= 2
488 rc = ldbm->del( ldbm, NULL, &key, 0 );
491 rc = ldbm->del( ldbm, &key, 0 );
493 ldbm->sync( ldbm, 0 );
501 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
506 #if DB_VERSION_MAJOR >= 2
509 ldbm_datum_init( key );
510 ldbm_datum_init( data );
512 key.flags = data.flags = DB_DBT_MALLOC;
516 /* acquire a cursor for the DB */
517 # if DB_VERSION_MAJOR >= 3 || (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR > 5)
518 rc = ldbm->cursor( ldbm, NULL, &dbci, 0 );
520 rc = ldbm->cursor( ldbm, NULL, &dbci );
527 if ( dbci->c_get( dbci, &key, &data, DB_NEXT ) == 0 ) {
528 ldbm_datum_free( ldbm, data );
540 rc = ldbm->seq( ldbm, &key, &data, R_FIRST );
543 key = ldbm_datum_dup( ldbm, key );
556 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
563 #if DB_VERSION_MAJOR >= 2
564 ldbm_datum_init( data );
566 ldbm_datum_free( ldbm, key );
567 key.flags = data.flags = DB_DBT_MALLOC;
569 rc = dbcp->c_get( dbcp, &key, &data, DB_NEXT );
571 ldbm_datum_free( ldbm, data );
574 rc = ldbm->seq( ldbm, &key, &data, R_NEXT );
577 key = ldbm_datum_dup( ldbm, key );
590 ldbm_errno( LDBM ldbm )
595 /******************************************************************
597 * END Berkeley section *
599 ******************************************************************/
601 #elif defined( HAVE_GDBM )
603 #ifdef HAVE_ST_BLKSIZE
604 #include <sys/stat.h>
607 /*****************************************************************
611 *****************************************************************/
614 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
617 #ifdef HAVE_ST_BLKSIZE
623 strncpy(n2, name, sizeof(n2)-1);
624 n2[sizeof(n2)-1] = '\0';
631 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
636 #ifdef HAVE_ST_BLKSIZE
637 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
638 dbcachesize /= st.st_blksize;
639 if( dbcachesize == 0 ) dbcachesize = 1;
640 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
643 if ( dbcachesize > 0 ) {
645 if( dbcachesize == 0 ) dbcachesize = 1;
646 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
656 ldbm_close( LDBM ldbm )
664 ldbm_sync( LDBM ldbm )
672 ldbm_fetch( LDBM ldbm, Datum key )
677 d = gdbm_fetch( ldbm, key );
684 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
689 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
690 if ( flags & LDBM_SYNC )
698 ldbm_delete( LDBM ldbm, Datum key )
703 rc = gdbm_delete( ldbm, key );
711 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
716 d = gdbm_firstkey( ldbm );
719 if ( d.dptr != NULL ) {
720 *dbcp = (Datum *) malloc( sizeof( Datum ) );
721 **dbcp = ldbm_datum_dup( ldbm, d );
728 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
733 d = gdbm_nextkey( ldbm, *dbcp );
736 ldbm_datum_free( ldbm, *dbcp );
738 if ( d.dptr != NULL ) {
739 *dbcp = ldbm_datum_dup( ldbm, d );
748 ldbm_errno( LDBM ldbm )
761 /* MMAPED DBM HASHING DATABASE */
763 #include <ac/string.h>
765 /* #define MDBM_DEBUG */
772 /* #define MDBM_CHAIN */
778 #define mdbm_store mdbm_chain_store
779 #define mdbm_fetch mdbm_chain_fetch
780 #define mdbm_delete mdbm_chain_delete
781 #define mdbm_first mdbm_chain_first
782 #define mdbm_next mdbm_chain_next
786 #define MDBM_PG_SZ (4*1024)
788 /*****************************************************************
792 *****************************************************************/
795 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
801 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
802 name ? name : "NULL", rw, mode, dbcachesize );
806 LDBM_WLOCK; /* We need locking here, this is the only non-thread
807 * safe function we have. */
809 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
812 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
819 (void)mdbm_set_chain(db);
825 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
833 ldbm_close( LDBM ldbm )
835 /* Open and close are not reentrant so we need to use locks here */
839 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
848 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
854 ldbm_sync( LDBM ldbm )
856 /* XXX: Not sure if this is re-entrant need to check code, if so
857 * you can leave LOCKS out.
865 #define MAX_MDBM_RETRY 5
868 ldbm_fetch( LDBM ldbm, Datum key )
874 /* This hack is needed because MDBM does not take keys
875 * which begin with NULL when working in the chaining
880 k.key.dsize = key.dsize + 1;
881 k.key.dptr = malloc(k.key.dsize);
883 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
893 d = mdbm_fetch( ldbm, k );
896 if ( k.val.dptr != NULL ) {
900 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
901 k.val.dsize = d.dsize;
902 d = mdbm_fetch( ldbm, k );
908 }/* if ( d.dsize > 0 ) */
909 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
920 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
923 Datum int_key; /* Internal key */
927 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
928 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
935 int_key.dsize = key.dsize + 1;
936 int_key.dptr = malloc( int_key.dsize );
937 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
938 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
943 rc = mdbm_store( ldbm, int_key, data, flags );
944 if ( flags & LDBM_SYNC ) {
951 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
963 ldbm_delete( LDBM ldbm, Datum key )
971 int_key.dsize = key.dsize + 1;
972 int_key.dptr = malloc(int_key.dsize);
973 *(int_key.dptr) = 'l';
974 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
979 rc = mdbm_delete( ldbm, int_key );
990 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
995 size_t sz = MDBM_PAGE_SIZE(ldbm);
1004 in.key.dsize = sz; /* Assume first key in one pg */
1005 in.key.dptr = malloc(sz);
1007 in.val.dptr = NULL; /* Don't need data just key */
1013 out = fptr( ldbm, in );
1015 if (out.key.dsize > 0) {
1016 ret.dsize = out.key.dsize - delta;
1018 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1023 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1035 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1037 return ldbm_get_next( ldbm, mdbm_first );
1041 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1044 * don't know if this will affect the LDAP server operation
1045 * but mdbm cannot take and input key.
1048 return ldbm_get_next( ldbm, mdbm_next );
1052 ldbm_errno( LDBM ldbm )
1054 /* XXX: best we can do with current mdbm interface */
1058 #elif defined( HAVE_NDBM )
1060 /*****************************************************************
1062 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1064 *****************************************************************/
1068 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
1073 ldbm = dbm_open( name, rw, mode );
1080 ldbm_close( LDBM ldbm )
1089 ldbm_sync( LDBM ldbm )
1095 ldbm_fetch( LDBM ldbm, Datum key )
1100 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1107 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1112 rc = dbm_store( ldbm, key, data, flags );
1119 ldbm_delete( LDBM ldbm, Datum key )
1124 rc = dbm_delete( ldbm, key );
1131 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1136 d = dbm_firstkey( ldbm );
1143 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1148 d = dbm_nextkey( ldbm );
1155 ldbm_errno( LDBM ldbm )
1160 err = dbm_error( ldbm );