1 /* ldbm.c - ldap dbm compatibility routines */
4 * Copyright 1998-2003 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 /* Let's make the version comparisons a little easier... */
96 #ifdef HAVE_BERKELEY_DB
97 #define DB_VERSION_X ((DB_VERSION_MAJOR<<16)|(DB_VERSION_MINOR<<8)|DB_VERSION_PATCH)
100 /*******************************************************************
102 * Create some special functions to initialize Berkeley DB for *
103 * versions greater than 2. *
105 *******************************************************************/
106 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
109 ldbm_malloc( size_t size )
111 /* likely should use ber_mem* routines */
112 return( calloc( 1, size ) );
116 #include <ac/syslog.h>
120 ldbm_db_errcall( const char *prefix, char *message )
123 syslog( LOG_INFO, "ldbm: %s %s", prefix, message );
127 int ldbm_initialize( const char* home )
129 #if DB_VERSION_MAJOR < 3
134 if(ldbm_initialized++) return 1;
138 int major, minor, patch;
139 version = db_version( &major, &minor, &patch );
141 if( major != DB_VERSION_MAJOR ||
142 minor < DB_VERSION_MINOR )
146 "ldbm_initialize(): version mismatch\nexpected: %s\ngot: %s\n",
147 DB_VERSION_STRING, version );
153 #if DB_VERSION_MAJOR < 3
154 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
156 if( ldbm_Env == NULL ) return 1;
158 ldbm_Env->db_errcall = ldbm_db_errcall;
159 ldbm_Env->db_errpfx = "==>";
161 envFlags = DB_CREATE | DB_USE_ENVIRON;
163 /* add optional flags */
165 envFlags |= DB_PRIVATE;
167 #ifdef HAVE_BERKELEY_DB_THREAD
168 envFlags |= DB_THREAD;
171 err = db_appinit( home, NULL, ldbm_Env, envFlags );
175 syslog( LOG_INFO, "ldbm_initialize(): "
176 "FATAL error (%d) in db_appinit()\n", err );
187 int ldbm_shutdown( void )
189 if( !ldbm_initialized ) return 1;
191 #if DB_VERSION_MAJOR < 3
192 db_appexit( ldbm_Env );
199 #else /* some DB other than Berkeley V2 or greater */
201 int ldbm_initialize( const char * home )
203 if(ldbm_initialized++) return 1;
210 int ldbm_shutdown( void )
212 if( !ldbm_initialized ) return 1;
219 #endif /* HAVE_BERKELEY_DB */
221 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 3)
223 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
232 err = db_env_create( &env, 0 );
236 syslog( LOG_INFO, "ldbm_initialize_env(): "
237 "FATAL error in db_env_create() : %s (%d)\n",
238 db_strerror( err ), err );
243 #if DB_VERSION_X >= 0x030300
244 /* This interface appeared in 3.3 */
245 env->set_alloc( env, ldbm_malloc, NULL, NULL );
248 env->set_errcall( env, ldbm_db_errcall );
249 env->set_errpfx( env, "==>" );
251 env->set_cachesize( env, 0, dbcachesize, 0 );
254 envFlags = DB_CREATE | DB_INIT_MPOOL | DB_USE_ENVIRON;
256 envFlags |= DB_PRIVATE;
258 #ifdef DB_MPOOL_PRIVATE
259 envFlags |= DB_MPOOL_PRIVATE;
261 #ifdef HAVE_BERKELEY_DB_THREAD
262 envFlags |= DB_THREAD;
266 strncpy(n2, home, sizeof(n2)-1);
267 n2[sizeof(n2)-1] = '\0';
271 #if DB_VERSION_X >= 0x030100
272 err = env->open( env, home, envFlags, 0 );
274 /* 3.0.x requires an extra argument */
275 err = env->open( env, home, NULL, envFlags, 0 );
280 syslog( LOG_INFO, "ldbm_initialize_env(): "
281 "FATAL error in dbEnv->open() : %s (%d)\n",
282 db_strerror( err ), err );
284 env->close( env, 0 );
292 void ldbm_shutdown_env(DB_ENV *env)
294 env->close( env, 0 );
299 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
304 void ldbm_shutdown_env(DB_ENV *env)
310 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
312 /*****************************************************************
314 * use berkeley db hash or btree package *
316 *****************************************************************/
319 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
326 #if DB_VERSION_MAJOR >= 3
331 err = db_create( &ret, env, 0 );
333 (void)ret->close(ret, 0);
339 #if DB_VERSION_X < 0x030300
340 ret->set_malloc( ret, ldbm_malloc );
343 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
345 /* likely should use ber_mem* routines */
348 strncpy(n2, name, sizeof(n2)-1);
349 n2[sizeof(n2)-1] = '\0';
353 #if DB_VERSION_X >= 0x040111
354 err = ret->open( ret, NULL, name, NULL, DB_TYPE, rw, mode);
356 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
361 (void)ret->close(ret, 0);
370 #elif DB_VERSION_MAJOR >= 2
373 memset( &dbinfo, '\0', sizeof( dbinfo ));
375 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
377 * BerkeleyDB 2.4 do not allow db_cachesize
378 * to be specified if an DB_ENV is.
381 /* set db_cachesize of MPOOL is NOT being used. */
382 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
383 dbinfo.db_cachesize = dbcachesize;
387 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
388 dbinfo.db_malloc = ldbm_malloc;
391 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
399 if ( DB_TYPE == DB_HASH ) {
400 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
401 hinfo.cachesize = dbcachesize;
403 } else if ( DB_TYPE == DB_BTREE ) {
404 memset( (char *) &binfo, '\0', sizeof(binfo) );
405 binfo.cachesize = dbcachesize;
412 ret = dbopen( name, rw, mode, DB_TYPE, info );
420 ldbm_close( LDBM ldbm )
423 #if DB_VERSION_MAJOR >= 2
424 ldbm->close( ldbm, 0 );
432 ldbm_sync( LDBM ldbm )
435 (*ldbm->sync)( ldbm, 0 );
440 ldbm_fetch( LDBM ldbm, Datum key )
447 #if DB_VERSION_MAJOR >= 2
448 ldbm_datum_init( data );
450 data.flags = DB_DBT_MALLOC;
452 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
453 ldbm_datum_free( ldbm, data );
458 if ( (rc = ldbm->get( ldbm, &key, &data, 0 )) == 0 ) {
459 /* Berkeley DB 1.85 don't malloc the data for us */
460 /* duplicate it for to ensure reentrancy */
461 data = ldbm_datum_dup( ldbm, data );
474 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
480 #if DB_VERSION_MAJOR >= 2
481 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
484 rc = ldbm->put( ldbm, &key, &data, flags & ~LDBM_SYNC );
487 if ( flags & LDBM_SYNC )
488 ldbm->sync( ldbm, 0 );
496 ldbm_delete( LDBM ldbm, Datum key )
502 #if DB_VERSION_MAJOR >= 2
503 rc = ldbm->del( ldbm, NULL, &key, 0 );
506 rc = ldbm->del( ldbm, &key, 0 );
508 ldbm->sync( ldbm, 0 );
516 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
521 #if DB_VERSION_MAJOR >= 2
524 ldbm_datum_init( key );
525 ldbm_datum_init( data );
527 key.flags = data.flags = DB_DBT_MALLOC;
531 /* acquire a cursor for the DB */
532 # if DB_VERSION_X >= 0x020600
533 rc = ldbm->cursor( ldbm, NULL, &dbci, 0 );
535 rc = ldbm->cursor( ldbm, NULL, &dbci );
542 if ( dbci->c_get( dbci, &key, &data, DB_NEXT ) == 0 ) {
543 ldbm_datum_free( ldbm, data );
555 rc = ldbm->seq( ldbm, &key, &data, R_FIRST );
558 key = ldbm_datum_dup( ldbm, key );
571 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
578 #if DB_VERSION_MAJOR >= 2
579 ldbm_datum_init( data );
581 ldbm_datum_free( ldbm, key );
582 key.flags = data.flags = DB_DBT_MALLOC;
584 rc = dbcp->c_get( dbcp, &key, &data, DB_NEXT );
586 ldbm_datum_free( ldbm, data );
589 rc = ldbm->seq( ldbm, &key, &data, R_NEXT );
592 key = ldbm_datum_dup( ldbm, key );
605 ldbm_errno( LDBM ldbm )
610 /******************************************************************
612 * END Berkeley section *
614 ******************************************************************/
616 #elif defined( HAVE_GDBM )
618 #ifdef HAVE_ST_BLKSIZE
619 #include <sys/stat.h>
622 /*****************************************************************
626 *****************************************************************/
629 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
632 #ifdef HAVE_ST_BLKSIZE
638 strncpy(n2, name, sizeof(n2)-1);
639 n2[sizeof(n2)-1] = '\0';
646 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
651 #ifdef HAVE_ST_BLKSIZE
652 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
653 dbcachesize /= st.st_blksize;
654 if( dbcachesize == 0 ) dbcachesize = 1;
655 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
658 if ( dbcachesize > 0 ) {
660 if( dbcachesize == 0 ) dbcachesize = 1;
661 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
671 ldbm_close( LDBM ldbm )
679 ldbm_sync( LDBM ldbm )
687 ldbm_fetch( LDBM ldbm, Datum key )
692 d = gdbm_fetch( ldbm, key );
699 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
704 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
705 if ( flags & LDBM_SYNC )
713 ldbm_delete( LDBM ldbm, Datum key )
718 rc = gdbm_delete( ldbm, key );
726 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
731 d = gdbm_firstkey( ldbm );
734 if ( d.dptr != NULL ) {
735 *dbcp = (Datum *) malloc( sizeof( Datum ) );
736 **dbcp = ldbm_datum_dup( ldbm, d );
743 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
748 d = gdbm_nextkey( ldbm, *dbcp );
751 ldbm_datum_free( ldbm, *dbcp );
753 if ( d.dptr != NULL ) {
754 *dbcp = ldbm_datum_dup( ldbm, d );
763 ldbm_errno( LDBM ldbm )
776 /* MMAPED DBM HASHING DATABASE */
778 #include <ac/string.h>
780 /* #define MDBM_DEBUG */
787 /* #define MDBM_CHAIN */
793 #define mdbm_store mdbm_chain_store
794 #define mdbm_fetch mdbm_chain_fetch
795 #define mdbm_delete mdbm_chain_delete
796 #define mdbm_first mdbm_chain_first
797 #define mdbm_next mdbm_chain_next
801 #define MDBM_PG_SZ (4*1024)
803 /*****************************************************************
807 *****************************************************************/
810 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
816 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
817 name ? name : "NULL", rw, mode, dbcachesize );
821 LDBM_WLOCK; /* We need locking here, this is the only non-thread
822 * safe function we have. */
824 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
827 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
834 (void)mdbm_set_chain(db);
840 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
848 ldbm_close( LDBM ldbm )
850 /* Open and close are not reentrant so we need to use locks here */
854 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
863 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
869 ldbm_sync( LDBM ldbm )
871 /* XXX: Not sure if this is re-entrant need to check code, if so
872 * you can leave LOCKS out.
880 #define MAX_MDBM_RETRY 5
883 ldbm_fetch( LDBM ldbm, Datum key )
889 /* This hack is needed because MDBM does not take keys
890 * which begin with NULL when working in the chaining
895 k.key.dsize = key.dsize + 1;
896 k.key.dptr = malloc(k.key.dsize);
898 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
908 d = mdbm_fetch( ldbm, k );
911 if ( k.val.dptr != NULL ) {
915 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
916 k.val.dsize = d.dsize;
917 d = mdbm_fetch( ldbm, k );
923 }/* if ( d.dsize > 0 ) */
924 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
935 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
938 Datum int_key; /* Internal key */
942 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
943 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
950 int_key.dsize = key.dsize + 1;
951 int_key.dptr = malloc( int_key.dsize );
952 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
953 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
958 rc = mdbm_store( ldbm, int_key, data, flags );
959 if ( flags & LDBM_SYNC ) {
966 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
978 ldbm_delete( LDBM ldbm, Datum key )
986 int_key.dsize = key.dsize + 1;
987 int_key.dptr = malloc(int_key.dsize);
988 *(int_key.dptr) = 'l';
989 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
994 rc = mdbm_delete( ldbm, int_key );
1005 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
1010 size_t sz = MDBM_PAGE_SIZE(ldbm);
1019 in.key.dsize = sz; /* Assume first key in one pg */
1020 in.key.dptr = malloc(sz);
1022 in.val.dptr = NULL; /* Don't need data just key */
1028 out = fptr( ldbm, in );
1030 if (out.key.dsize > 0) {
1031 ret.dsize = out.key.dsize - delta;
1033 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1038 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1050 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1052 return ldbm_get_next( ldbm, mdbm_first );
1056 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1059 * don't know if this will affect the LDAP server operation
1060 * but mdbm cannot take and input key.
1063 return ldbm_get_next( ldbm, mdbm_next );
1067 ldbm_errno( LDBM ldbm )
1069 /* XXX: best we can do with current mdbm interface */
1073 #elif defined( HAVE_NDBM )
1075 /*****************************************************************
1077 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1079 *****************************************************************/
1083 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
1088 ldbm = dbm_open( name, rw, mode );
1095 ldbm_close( LDBM ldbm )
1104 ldbm_sync( LDBM ldbm )
1110 ldbm_fetch( LDBM ldbm, Datum key )
1115 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1122 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1127 rc = dbm_store( ldbm, key, data, flags );
1134 ldbm_delete( LDBM ldbm, Datum key )
1139 rc = dbm_delete( ldbm, key );
1146 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1151 d = dbm_firstkey( ldbm );
1158 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1163 d = dbm_nextkey( ldbm );
1170 ldbm_errno( LDBM ldbm )
1175 err = dbm_error( ldbm );