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 );
237 env->set_errcall( env, ldbm_db_errcall );
238 env->set_errpfx( env, "==>" );
240 env->set_cachesize( env, 0, dbcachesize, 0 );
243 envFlags = DB_CREATE | DB_INIT_MPOOL | DB_USE_ENVIRON;
245 envFlags |= DB_PRIVATE;
247 #ifdef DB_MPOOL_PRIVATE
248 envFlags |= DB_MPOOL_PRIVATE;
250 #ifdef HAVE_BERKELEY_DB_THREAD
251 envFlags |= DB_THREAD;
254 #if DB_VERSION_MAJOR > 3 || DB_VERSION_MINOR > 0
255 err = env->open( env, home, envFlags, 0 );
257 /* 3.0.x requires an extra argument */
258 err = env->open( env, home, NULL, envFlags, 0 );
263 syslog( LOG_INFO, "ldbm_initialize_env(): "
264 "FATAL error in dbEnv->open() : %s (%d)\n",
265 db_strerror( err ), err );
267 env->close( env, 0 );
275 void ldbm_shutdown_env(DB_ENV *env)
277 env->close( env, 0 );
282 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
287 void ldbm_shutdown_env(DB_ENV *env)
293 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
295 /*****************************************************************
297 * use berkeley db hash or btree package *
299 *****************************************************************/
302 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
306 #if DB_VERSION_MAJOR >= 3
311 err = db_create( &ret, env, 0 );
313 (void)ret->close(ret, 0);
319 #if DB_VERSION_MINOR < 3
320 ret->set_malloc( ret, ldbm_malloc );
323 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
325 /* likely should use ber_mem* routines */
327 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
331 (void)ret->close(ret, 0);
340 #elif DB_VERSION_MAJOR >= 2
343 memset( &dbinfo, '\0', sizeof( dbinfo ));
345 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
347 * BerkeleyDB 2.4 do not allow db_cachesize
348 * to be specified if an DB_ENV is.
351 /* set db_cachesize of MPOOL is NOT being used. */
352 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
353 dbinfo.db_cachesize = dbcachesize;
357 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
358 dbinfo.db_malloc = ldbm_malloc;
361 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
369 if ( DB_TYPE == DB_HASH ) {
370 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
371 hinfo.cachesize = dbcachesize;
373 } else if ( DB_TYPE == DB_BTREE ) {
374 memset( (char *) &binfo, '\0', sizeof(binfo) );
375 binfo.cachesize = dbcachesize;
382 ret = dbopen( name, rw, mode, DB_TYPE, info );
390 ldbm_close( LDBM ldbm )
393 #if DB_VERSION_MAJOR >= 3
394 ldbm->close( ldbm, 0 );
395 #elif DB_VERSION_MAJOR >= 2
396 (*ldbm->close)( ldbm, 0 );
398 (*ldbm->close)( ldbm );
404 ldbm_sync( LDBM ldbm )
407 (*ldbm->sync)( ldbm, 0 );
412 ldbm_fetch( LDBM ldbm, Datum key )
419 #if DB_VERSION_MAJOR >= 3
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 #elif DB_VERSION_MAJOR >= 2
431 ldbm_datum_init( data );
433 data.flags = DB_DBT_MALLOC;
435 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
436 ldbm_datum_free( ldbm, data );
442 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
443 /* Berkeley DB 1.85 don't malloc the data for us */
444 /* duplicate it for to ensure reentrancy */
445 data = ldbm_datum_dup( ldbm, data );
458 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
464 #if DB_VERSION_MAJOR >= 3
465 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
468 #elif DB_VERSION_MAJOR >= 2
469 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
472 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
475 if ( flags & LDBM_SYNC )
476 (*ldbm->sync)( ldbm, 0 );
484 ldbm_delete( LDBM ldbm, Datum key )
490 #if DB_VERSION_MAJOR >= 3
491 rc = ldbm->del( ldbm, NULL, &key, 0 );
493 #elif 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_MAJOR >= 3
524 rc = ldbm->cursor( ldbm, NULL, &dbci, 0 );
525 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
526 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
527 rc = (*ldbm->cursor)( ldbm, NULL, &dbci );
529 rc = (*ldbm->cursor)( ldbm, NULL, &dbci, 0 );
536 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
537 ldbm_datum_free( ldbm, data );
549 rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST );
552 key = ldbm_datum_dup( ldbm, key );
565 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
572 #if DB_VERSION_MAJOR >= 2
573 ldbm_datum_init( data );
575 ldbm_datum_free( ldbm, key );
576 key.flags = data.flags = DB_DBT_MALLOC;
578 rc = (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT );
580 ldbm_datum_free( ldbm, data );
583 rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT );
586 key = ldbm_datum_dup( ldbm, key );
599 ldbm_errno( LDBM ldbm )
604 /******************************************************************
606 * END Berkeley section *
608 ******************************************************************/
610 #elif defined( HAVE_GDBM )
612 #ifdef HAVE_ST_BLKSIZE
613 #include <sys/stat.h>
616 /*****************************************************************
620 *****************************************************************/
623 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
626 #ifdef HAVE_ST_BLKSIZE
632 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
637 #ifdef HAVE_ST_BLKSIZE
638 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
639 dbcachesize /= st.st_blksize;
640 if( dbcachesize == 0 ) dbcachesize = 1;
641 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
644 if ( dbcachesize > 0 ) {
646 if( dbcachesize == 0 ) dbcachesize = 1;
647 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
657 ldbm_close( LDBM ldbm )
665 ldbm_sync( LDBM ldbm )
673 ldbm_fetch( LDBM ldbm, Datum key )
678 d = gdbm_fetch( ldbm, key );
685 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
690 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
691 if ( flags & LDBM_SYNC )
699 ldbm_delete( LDBM ldbm, Datum key )
704 rc = gdbm_delete( ldbm, key );
712 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
717 d = gdbm_firstkey( ldbm );
720 if ( d.dptr != NULL ) {
721 *dbcp = (Datum *) malloc( sizeof( Datum ) );
722 **dbcp = ldbm_datum_dup( ldbm, d );
729 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
734 d = gdbm_nextkey( ldbm, *dbcp );
737 ldbm_datum_free( ldbm, *dbcp );
739 if ( d.dptr != NULL ) {
740 *dbcp = ldbm_datum_dup( ldbm, d );
749 ldbm_errno( LDBM ldbm )
762 /* MMAPED DBM HASHING DATABASE */
764 #include <ac/string.h>
766 /* #define MDBM_DEBUG */
773 /* #define MDBM_CHAIN */
779 #define mdbm_store mdbm_chain_store
780 #define mdbm_fetch mdbm_chain_fetch
781 #define mdbm_delete mdbm_chain_delete
782 #define mdbm_first mdbm_chain_first
783 #define mdbm_next mdbm_chain_next
787 #define MDBM_PG_SZ (4*1024)
789 /*****************************************************************
793 *****************************************************************/
796 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
802 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
803 name ? name : "NULL", rw, mode, dbcachesize );
807 LDBM_WLOCK; /* We need locking here, this is the only non-thread
808 * safe function we have. */
810 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
813 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
820 (void)mdbm_set_chain(db);
826 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
834 ldbm_close( LDBM ldbm )
836 /* Open and close are not reentrant so we need to use locks here */
840 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
849 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
855 ldbm_sync( LDBM ldbm )
857 /* XXX: Not sure if this is re-entrant need to check code, if so
858 * you can leave LOCKS out.
866 #define MAX_MDBM_RETRY 5
869 ldbm_fetch( LDBM ldbm, Datum key )
875 /* This hack is needed because MDBM does not take keys
876 * which begin with NULL when working in the chaining
881 k.key.dsize = key.dsize + 1;
882 k.key.dptr = malloc(k.key.dsize);
884 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
894 d = mdbm_fetch( ldbm, k );
897 if ( k.val.dptr != NULL ) {
901 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
902 k.val.dsize = d.dsize;
903 d = mdbm_fetch( ldbm, k );
909 }/* if ( d.dsize > 0 ) */
910 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
921 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
924 Datum int_key; /* Internal key */
928 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
929 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
936 int_key.dsize = key.dsize + 1;
937 int_key.dptr = malloc( int_key.dsize );
938 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
939 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
944 rc = mdbm_store( ldbm, int_key, data, flags );
945 if ( flags & LDBM_SYNC ) {
952 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
964 ldbm_delete( LDBM ldbm, Datum key )
972 int_key.dsize = key.dsize + 1;
973 int_key.dptr = malloc(int_key.dsize);
974 *(int_key.dptr) = 'l';
975 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
980 rc = mdbm_delete( ldbm, int_key );
991 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
996 size_t sz = MDBM_PAGE_SIZE(ldbm);
1005 in.key.dsize = sz; /* Assume first key in one pg */
1006 in.key.dptr = malloc(sz);
1008 in.val.dptr = NULL; /* Don't need data just key */
1014 out = fptr( ldbm, in );
1016 if (out.key.dsize > 0) {
1017 ret.dsize = out.key.dsize - delta;
1019 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1024 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1036 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1038 return ldbm_get_next( ldbm, mdbm_first );
1042 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1045 * don't know if this will affect the LDAP server operation
1046 * but mdbm cannot take and input key.
1049 return ldbm_get_next( ldbm, mdbm_next );
1053 ldbm_errno( LDBM ldbm )
1055 /* XXX: best we can do with current mdbm interface */
1059 #elif defined( HAVE_NDBM )
1061 /*****************************************************************
1063 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1065 *****************************************************************/
1069 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
1074 ldbm = dbm_open( name, rw, mode );
1081 ldbm_close( LDBM ldbm )
1090 ldbm_sync( LDBM ldbm )
1096 ldbm_fetch( LDBM ldbm, Datum key )
1101 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1108 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1113 rc = dbm_store( ldbm, key, data, flags );
1120 ldbm_delete( LDBM ldbm, Datum key )
1125 rc = dbm_delete( ldbm, key );
1132 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1137 d = dbm_firstkey( ldbm );
1144 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1149 d = dbm_nextkey( ldbm );
1156 ldbm_errno( LDBM ldbm )
1161 err = dbm_error( ldbm );