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
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 )
126 if(ldbm_initialized++) return 1;
130 int major, minor, patch;
131 version = db_version( &major, &minor, &patch );
133 if( major != DB_VERSION_MAJOR ||
134 minor < DB_VERSION_MINOR )
138 "ldbm_initialize(): version mismatch\nexpected: %s\ngot: %s\n",
139 DB_VERSION_STRING, version );
145 #if DB_VERSION_MAJOR < 3
146 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
148 if( ldbm_Env == NULL ) return 1;
150 ldbm_Env->db_errcall = ldbm_db_errcall;
151 ldbm_Env->db_errpfx = "==>";
153 envFlags = DB_CREATE | DB_USE_ENVIRON;
155 /* add optional flags */
157 envFlags |= DB_PRIVATE;
159 #ifdef HAVE_BERKELEY_DB_THREAD
160 envFlags |= DB_THREAD;
163 err = db_appinit( home, NULL, ldbm_Env, envFlags );
167 syslog( LOG_INFO, "ldbm_initialize(): "
168 "FATAL error in db_appinit() : %s (%d)\n",
169 db_strerror( err ), err );
180 int ldbm_shutdown( void )
182 if( !ldbm_initialized ) return 1;
184 #if DB_VERSION_MAJOR < 3
185 db_appexit( ldbm_Env );
192 #else /* some DB other than Berkeley V2 or greater */
194 int ldbm_initialize( const char * home )
196 if(ldbm_initialized++) return 1;
203 int ldbm_shutdown( void )
205 if( !ldbm_initialized ) return 1;
212 #endif /* HAVE_BERKELEY_DB */
214 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 3)
216 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
222 err = db_env_create( &env, 0 );
226 syslog( LOG_INFO, "ldbm_initialize_env(): "
227 "FATAL error in db_env_create() : %s (%d)\n",
228 db_strerror( err ), err );
233 #if DB_VERSION_MINOR >= 3
234 env->set_alloc( env, ldbm_malloc, NULL, NULL );
236 env->set_malloc( env, ldbm_malloc );
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 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
323 /* likely should use ber_mem* routines */
325 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
329 (void)ret->close(ret, 0);
338 #elif DB_VERSION_MAJOR >= 2
341 memset( &dbinfo, '\0', sizeof( dbinfo ));
343 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
345 * BerkeleyDB 2.4 do not allow db_cachesize
346 * to be specified if an DB_ENV is.
349 /* set db_cachesize of MPOOL is NOT being used. */
350 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
351 dbinfo.db_cachesize = dbcachesize;
355 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
356 dbinfo.db_malloc = ldbm_malloc;
359 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
367 if ( DB_TYPE == DB_HASH ) {
368 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
369 hinfo.cachesize = dbcachesize;
371 } else if ( DB_TYPE == DB_BTREE ) {
372 memset( (char *) &binfo, '\0', sizeof(binfo) );
373 binfo.cachesize = dbcachesize;
380 ret = dbopen( name, rw, mode, DB_TYPE, info );
388 ldbm_close( LDBM ldbm )
391 #if DB_VERSION_MAJOR >= 3
392 ldbm->close( ldbm, 0 );
393 #elif DB_VERSION_MAJOR >= 2
394 (*ldbm->close)( ldbm, 0 );
396 (*ldbm->close)( ldbm );
402 ldbm_sync( LDBM ldbm )
405 (*ldbm->sync)( ldbm, 0 );
410 ldbm_fetch( LDBM ldbm, Datum key )
417 #if DB_VERSION_MAJOR >= 3
418 ldbm_datum_init( data );
420 data.flags = DB_DBT_MALLOC;
422 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
423 ldbm_datum_free( ldbm, data );
428 #elif DB_VERSION_MAJOR >= 2
429 ldbm_datum_init( data );
431 data.flags = DB_DBT_MALLOC;
433 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
434 ldbm_datum_free( ldbm, data );
440 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
441 /* Berkeley DB 1.85 don't malloc the data for us */
442 /* duplicate it for to ensure reentrancy */
443 data = ldbm_datum_dup( ldbm, data );
456 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
462 #if DB_VERSION_MAJOR >= 3
463 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
466 #elif DB_VERSION_MAJOR >= 2
467 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
470 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
473 if ( flags & LDBM_SYNC )
474 (*ldbm->sync)( ldbm, 0 );
482 ldbm_delete( LDBM ldbm, Datum key )
488 #if DB_VERSION_MAJOR >= 3
489 rc = ldbm->del( ldbm, NULL, &key, 0 );
491 #elif DB_VERSION_MAJOR >= 2
492 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
495 rc = (*ldbm->del)( ldbm, &key, 0 );
497 (*ldbm->sync)( ldbm, 0 );
505 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
510 #if DB_VERSION_MAJOR >= 2
513 ldbm_datum_init( key );
514 ldbm_datum_init( data );
516 key.flags = data.flags = DB_DBT_MALLOC;
520 /* acquire a cursor for the DB */
521 # if DB_VERSION_MAJOR >= 3
522 rc = ldbm->cursor( ldbm, NULL, &dbci, 0 );
523 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
524 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
525 rc = (*ldbm->cursor)( ldbm, NULL, &dbci );
527 rc = (*ldbm->cursor)( ldbm, NULL, &dbci, 0 );
534 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
535 ldbm_datum_free( ldbm, data );
547 rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST );
550 key = ldbm_datum_dup( ldbm, key );
563 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
570 #if DB_VERSION_MAJOR >= 2
571 ldbm_datum_init( data );
573 ldbm_datum_free( ldbm, key );
574 key.flags = data.flags = DB_DBT_MALLOC;
576 rc = (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT );
578 ldbm_datum_free( ldbm, data );
581 rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT );
584 key = ldbm_datum_dup( ldbm, key );
597 ldbm_errno( LDBM ldbm )
602 /******************************************************************
604 * END Berkeley section *
606 ******************************************************************/
608 #elif defined( HAVE_GDBM )
610 #ifdef HAVE_ST_BLKSIZE
611 #include <sys/stat.h>
614 /*****************************************************************
618 *****************************************************************/
621 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
624 #ifdef HAVE_ST_BLKSIZE
630 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
635 #ifdef HAVE_ST_BLKSIZE
636 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
637 dbcachesize /= st.st_blksize;
638 if( dbcachesize == 0 ) dbcachesize = 1;
639 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
642 if ( dbcachesize > 0 ) {
644 if( dbcachesize == 0 ) dbcachesize = 1;
645 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
655 ldbm_close( LDBM ldbm )
663 ldbm_sync( LDBM ldbm )
671 ldbm_fetch( LDBM ldbm, Datum key )
676 d = gdbm_fetch( ldbm, key );
683 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
688 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
689 if ( flags & LDBM_SYNC )
697 ldbm_delete( LDBM ldbm, Datum key )
702 rc = gdbm_delete( ldbm, key );
710 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
715 d = gdbm_firstkey( ldbm );
718 if ( d.dptr != NULL ) {
719 *dbcp = (Datum *) malloc( sizeof( Datum ) );
720 **dbcp = ldbm_datum_dup( ldbm, d );
727 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
732 d = gdbm_nextkey( ldbm, *dbcp );
735 ldbm_datum_free( ldbm, *dbcp );
737 if ( d.dptr != NULL ) {
738 *dbcp = ldbm_datum_dup( ldbm, d );
747 ldbm_errno( LDBM ldbm )
760 /* MMAPED DBM HASHING DATABASE */
762 #include <ac/string.h>
764 /* #define MDBM_DEBUG */
771 /* #define MDBM_CHAIN */
777 #define mdbm_store mdbm_chain_store
778 #define mdbm_fetch mdbm_chain_fetch
779 #define mdbm_delete mdbm_chain_delete
780 #define mdbm_first mdbm_chain_first
781 #define mdbm_next mdbm_chain_next
785 #define MDBM_PG_SZ (4*1024)
787 /*****************************************************************
791 *****************************************************************/
794 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
800 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
801 name ? name : "NULL", rw, mode, dbcachesize );
805 LDBM_WLOCK; /* We need locking here, this is the only non-thread
806 * safe function we have. */
808 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
811 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
818 (void)mdbm_set_chain(db);
824 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
832 ldbm_close( LDBM ldbm )
834 /* Open and close are not reentrant so we need to use locks here */
838 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
847 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
853 ldbm_sync( LDBM ldbm )
855 /* XXX: Not sure if this is re-entrant need to check code, if so
856 * you can leave LOCKS out.
864 #define MAX_MDBM_RETRY 5
867 ldbm_fetch( LDBM ldbm, Datum key )
873 /* This hack is needed because MDBM does not take keys
874 * which begin with NULL when working in the chaining
879 k.key.dsize = key.dsize + 1;
880 k.key.dptr = malloc(k.key.dsize);
882 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
892 d = mdbm_fetch( ldbm, k );
895 if ( k.val.dptr != NULL ) {
899 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
900 k.val.dsize = d.dsize;
901 d = mdbm_fetch( ldbm, k );
907 }/* if ( d.dsize > 0 ) */
908 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
919 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
922 Datum int_key; /* Internal key */
926 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
927 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
934 int_key.dsize = key.dsize + 1;
935 int_key.dptr = malloc( int_key.dsize );
936 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
937 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
942 rc = mdbm_store( ldbm, int_key, data, flags );
943 if ( flags & LDBM_SYNC ) {
950 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
962 ldbm_delete( LDBM ldbm, Datum key )
970 int_key.dsize = key.dsize + 1;
971 int_key.dptr = malloc(int_key.dsize);
972 *(int_key.dptr) = 'l';
973 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
978 rc = mdbm_delete( ldbm, int_key );
989 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
994 size_t sz = MDBM_PAGE_SIZE(ldbm);
1003 in.key.dsize = sz; /* Assume first key in one pg */
1004 in.key.dptr = malloc(sz);
1006 in.val.dptr = NULL; /* Don't need data just key */
1012 out = fptr( ldbm, in );
1014 if (out.key.dsize > 0) {
1015 ret.dsize = out.key.dsize - delta;
1017 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1022 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1034 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1036 return ldbm_get_next( ldbm, mdbm_first );
1040 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1043 * don't know if this will affect the LDAP server operation
1044 * but mdbm cannot take and input key.
1047 return ldbm_get_next( ldbm, mdbm_next );
1051 ldbm_errno( LDBM ldbm )
1053 /* XXX: best we can do with current mdbm interface */
1057 #elif defined( HAVE_NDBM )
1059 /*****************************************************************
1061 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1063 *****************************************************************/
1067 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
1072 ldbm = dbm_open( name, rw, mode );
1079 ldbm_close( LDBM ldbm )
1088 ldbm_sync( LDBM ldbm )
1094 ldbm_fetch( LDBM ldbm, Datum key )
1099 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1106 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1111 rc = dbm_store( ldbm, key, data, flags );
1118 ldbm_delete( LDBM ldbm, Datum key )
1123 rc = dbm_delete( ldbm, key );
1130 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1135 d = dbm_firstkey( ldbm );
1142 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1147 d = dbm_nextkey( ldbm );
1154 ldbm_errno( LDBM ldbm )
1159 err = dbm_error( ldbm );