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)
229 err = db_env_create( &env, 0 );
233 syslog( LOG_INFO, "ldbm_initialize_env(): "
234 "FATAL error in db_env_create() : %s (%d)\n",
235 db_strerror( err ), err );
240 #if DB_VERSION_X >= 0x030300
241 /* This interface appeared in 3.3 */
242 env->set_alloc( env, ldbm_malloc, NULL, NULL );
245 env->set_errcall( env, ldbm_db_errcall );
246 env->set_errpfx( env, "==>" );
248 env->set_cachesize( env, 0, dbcachesize, 0 );
251 envFlags = DB_CREATE | DB_INIT_MPOOL | DB_USE_ENVIRON;
253 envFlags |= DB_PRIVATE;
255 #ifdef DB_MPOOL_PRIVATE
256 envFlags |= DB_MPOOL_PRIVATE;
258 #ifdef HAVE_BERKELEY_DB_THREAD
259 envFlags |= DB_THREAD;
262 #if DB_VERSION_X >= 0x030100
263 err = env->open( env, home, envFlags, 0 );
265 /* 3.0.x requires an extra argument */
266 err = env->open( env, home, NULL, envFlags, 0 );
271 syslog( LOG_INFO, "ldbm_initialize_env(): "
272 "FATAL error in dbEnv->open() : %s (%d)\n",
273 db_strerror( err ), err );
275 env->close( env, 0 );
283 void ldbm_shutdown_env(DB_ENV *env)
285 env->close( env, 0 );
290 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
295 void ldbm_shutdown_env(DB_ENV *env)
301 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
303 /*****************************************************************
305 * use berkeley db hash or btree package *
307 *****************************************************************/
310 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
317 #if DB_VERSION_MAJOR >= 3
322 err = db_create( &ret, env, 0 );
324 (void)ret->close(ret, 0);
330 #if DB_VERSION_X < 0x030300
331 ret->set_malloc( ret, ldbm_malloc );
334 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
336 /* likely should use ber_mem* routines */
339 strncpy(n2, name, sizeof(n2)-1);
340 n2[sizeof(n2)-1] = '\0';
344 #if DB_VERSION_X >= 0x040111
345 err = ret->open( ret, NULL, name, NULL, DB_TYPE, rw, mode);
347 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
352 (void)ret->close(ret, 0);
361 #elif DB_VERSION_MAJOR >= 2
364 memset( &dbinfo, '\0', sizeof( dbinfo ));
366 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
368 * BerkeleyDB 2.4 do not allow db_cachesize
369 * to be specified if an DB_ENV is.
372 /* set db_cachesize of MPOOL is NOT being used. */
373 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
374 dbinfo.db_cachesize = dbcachesize;
378 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
379 dbinfo.db_malloc = ldbm_malloc;
382 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
390 if ( DB_TYPE == DB_HASH ) {
391 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
392 hinfo.cachesize = dbcachesize;
394 } else if ( DB_TYPE == DB_BTREE ) {
395 memset( (char *) &binfo, '\0', sizeof(binfo) );
396 binfo.cachesize = dbcachesize;
403 ret = dbopen( name, rw, mode, DB_TYPE, info );
411 ldbm_close( LDBM ldbm )
414 #if DB_VERSION_MAJOR >= 2
415 ldbm->close( ldbm, 0 );
423 ldbm_sync( LDBM ldbm )
426 (*ldbm->sync)( ldbm, 0 );
431 ldbm_fetch( LDBM ldbm, Datum key )
438 #if DB_VERSION_MAJOR >= 2
439 ldbm_datum_init( data );
441 data.flags = DB_DBT_MALLOC;
443 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
444 ldbm_datum_free( ldbm, data );
449 if ( (rc = ldbm->get( ldbm, &key, &data, 0 )) == 0 ) {
450 /* Berkeley DB 1.85 don't malloc the data for us */
451 /* duplicate it for to ensure reentrancy */
452 data = ldbm_datum_dup( ldbm, data );
465 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
471 #if DB_VERSION_MAJOR >= 2
472 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
475 rc = ldbm->put( ldbm, &key, &data, flags & ~LDBM_SYNC );
478 if ( flags & LDBM_SYNC )
479 ldbm->sync( ldbm, 0 );
487 ldbm_delete( LDBM ldbm, Datum key )
493 #if DB_VERSION_MAJOR >= 2
494 rc = ldbm->del( ldbm, NULL, &key, 0 );
497 rc = ldbm->del( ldbm, &key, 0 );
499 ldbm->sync( ldbm, 0 );
507 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
512 #if DB_VERSION_MAJOR >= 2
515 ldbm_datum_init( key );
516 ldbm_datum_init( data );
518 key.flags = data.flags = DB_DBT_MALLOC;
522 /* acquire a cursor for the DB */
523 # if DB_VERSION_X >= 0x020600
524 rc = ldbm->cursor( ldbm, NULL, &dbci, 0 );
526 rc = ldbm->cursor( ldbm, NULL, &dbci );
533 if ( dbci->c_get( dbci, &key, &data, DB_NEXT ) == 0 ) {
534 ldbm_datum_free( ldbm, data );
546 rc = ldbm->seq( ldbm, &key, &data, R_FIRST );
549 key = ldbm_datum_dup( ldbm, key );
562 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
569 #if DB_VERSION_MAJOR >= 2
570 ldbm_datum_init( data );
572 ldbm_datum_free( ldbm, key );
573 key.flags = data.flags = DB_DBT_MALLOC;
575 rc = dbcp->c_get( dbcp, &key, &data, DB_NEXT );
577 ldbm_datum_free( ldbm, data );
580 rc = ldbm->seq( ldbm, &key, &data, R_NEXT );
583 key = ldbm_datum_dup( ldbm, key );
596 ldbm_errno( LDBM ldbm )
601 /******************************************************************
603 * END Berkeley section *
605 ******************************************************************/
607 #elif defined( HAVE_GDBM )
609 #ifdef HAVE_ST_BLKSIZE
610 #include <sys/stat.h>
613 /*****************************************************************
617 *****************************************************************/
620 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
623 #ifdef HAVE_ST_BLKSIZE
629 strncpy(n2, name, sizeof(n2)-1);
630 n2[sizeof(n2)-1] = '\0';
637 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
642 #ifdef HAVE_ST_BLKSIZE
643 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
644 dbcachesize /= st.st_blksize;
645 if( dbcachesize == 0 ) dbcachesize = 1;
646 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
649 if ( dbcachesize > 0 ) {
651 if( dbcachesize == 0 ) dbcachesize = 1;
652 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
662 ldbm_close( LDBM ldbm )
670 ldbm_sync( LDBM ldbm )
678 ldbm_fetch( LDBM ldbm, Datum key )
683 d = gdbm_fetch( ldbm, key );
690 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
695 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
696 if ( flags & LDBM_SYNC )
704 ldbm_delete( LDBM ldbm, Datum key )
709 rc = gdbm_delete( ldbm, key );
717 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
722 d = gdbm_firstkey( ldbm );
725 if ( d.dptr != NULL ) {
726 *dbcp = (Datum *) malloc( sizeof( Datum ) );
727 **dbcp = ldbm_datum_dup( ldbm, d );
734 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
739 d = gdbm_nextkey( ldbm, *dbcp );
742 ldbm_datum_free( ldbm, *dbcp );
744 if ( d.dptr != NULL ) {
745 *dbcp = ldbm_datum_dup( ldbm, d );
754 ldbm_errno( LDBM ldbm )
767 /* MMAPED DBM HASHING DATABASE */
769 #include <ac/string.h>
771 /* #define MDBM_DEBUG */
778 /* #define MDBM_CHAIN */
784 #define mdbm_store mdbm_chain_store
785 #define mdbm_fetch mdbm_chain_fetch
786 #define mdbm_delete mdbm_chain_delete
787 #define mdbm_first mdbm_chain_first
788 #define mdbm_next mdbm_chain_next
792 #define MDBM_PG_SZ (4*1024)
794 /*****************************************************************
798 *****************************************************************/
801 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
807 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
808 name ? name : "NULL", rw, mode, dbcachesize );
812 LDBM_WLOCK; /* We need locking here, this is the only non-thread
813 * safe function we have. */
815 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
818 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
825 (void)mdbm_set_chain(db);
831 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
839 ldbm_close( LDBM ldbm )
841 /* Open and close are not reentrant so we need to use locks here */
845 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
854 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
860 ldbm_sync( LDBM ldbm )
862 /* XXX: Not sure if this is re-entrant need to check code, if so
863 * you can leave LOCKS out.
871 #define MAX_MDBM_RETRY 5
874 ldbm_fetch( LDBM ldbm, Datum key )
880 /* This hack is needed because MDBM does not take keys
881 * which begin with NULL when working in the chaining
886 k.key.dsize = key.dsize + 1;
887 k.key.dptr = malloc(k.key.dsize);
889 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
899 d = mdbm_fetch( ldbm, k );
902 if ( k.val.dptr != NULL ) {
906 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
907 k.val.dsize = d.dsize;
908 d = mdbm_fetch( ldbm, k );
914 }/* if ( d.dsize > 0 ) */
915 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
926 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
929 Datum int_key; /* Internal key */
933 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
934 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
941 int_key.dsize = key.dsize + 1;
942 int_key.dptr = malloc( int_key.dsize );
943 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
944 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
949 rc = mdbm_store( ldbm, int_key, data, flags );
950 if ( flags & LDBM_SYNC ) {
957 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
969 ldbm_delete( LDBM ldbm, Datum key )
977 int_key.dsize = key.dsize + 1;
978 int_key.dptr = malloc(int_key.dsize);
979 *(int_key.dptr) = 'l';
980 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
985 rc = mdbm_delete( ldbm, int_key );
996 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
1001 size_t sz = MDBM_PAGE_SIZE(ldbm);
1010 in.key.dsize = sz; /* Assume first key in one pg */
1011 in.key.dptr = malloc(sz);
1013 in.val.dptr = NULL; /* Don't need data just key */
1019 out = fptr( ldbm, in );
1021 if (out.key.dsize > 0) {
1022 ret.dsize = out.key.dsize - delta;
1024 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1029 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1041 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1043 return ldbm_get_next( ldbm, mdbm_first );
1047 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1050 * don't know if this will affect the LDAP server operation
1051 * but mdbm cannot take and input key.
1054 return ldbm_get_next( ldbm, mdbm_next );
1058 ldbm_errno( LDBM ldbm )
1060 /* XXX: best we can do with current mdbm interface */
1064 #elif defined( HAVE_NDBM )
1066 /*****************************************************************
1068 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1070 *****************************************************************/
1074 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
1079 ldbm = dbm_open( name, rw, mode );
1086 ldbm_close( LDBM ldbm )
1095 ldbm_sync( LDBM ldbm )
1101 ldbm_fetch( LDBM ldbm, Datum key )
1106 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1113 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1118 rc = dbm_store( ldbm, key, data, flags );
1125 ldbm_delete( LDBM ldbm, Datum key )
1130 rc = dbm_delete( ldbm, key );
1137 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1142 d = dbm_firstkey( ldbm );
1149 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1154 d = dbm_nextkey( ldbm );
1161 ldbm_errno( LDBM ldbm )
1166 err = dbm_error( ldbm );