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
10 * - DB version 2.6.4b ; 1998/12/28, /KSp
11 * - DB_DBT_MALLOC ; 1998/03/22, /KSp
12 * - basic implementation; 1998/02/23, /KSp
21 #include <ac/stdlib.h>
22 #include <ac/string.h>
26 #include "ldap_pvt_thread.h"
29 ldbm_datum_free( LDBM ldbm, Datum data )
33 memset( &data, '\0', sizeof( Datum ));
40 ldbm_datum_dup( LDBM ldbm, Datum data )
44 ldbm_datum_init( dup );
46 if ( data.dsize == 0 ) {
52 dup.dsize = data.dsize;
54 if ( (dup.dptr = (char *) malloc( data.dsize )) != NULL ) {
55 AC_MEMCPY( dup.dptr, data.dptr, data.dsize );
61 static int ldbm_initialized = 0;
63 #ifdef HAVE_BERKELEY_DB_THREAD
64 #define LDBM_LOCK ((void) 0)
65 #define LDBM_UNLOCK ((void) 0)
67 static ldap_pvt_thread_mutex_t ldbm_big_mutex;
68 #define LDBM_LOCK (ldap_pvt_thread_mutex_lock(&ldbm_big_mutex))
69 #define LDBM_UNLOCK (ldap_pvt_thread_mutex_unlock(&ldbm_big_mutex))
72 #if !defined( HAVE_BERKELEY_DB ) || (DB_VERSION_MAJOR < 3)
73 /* a dbEnv for BERKELEYv2 */
74 DB_ENV *ldbm_Env = NULL; /* real or fake, depending on db and version */
78 /*******************************************************************
80 * Create some special functions to initialize Berkeley DB for *
81 * versions greater than 2. *
83 *******************************************************************/
84 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
87 ldbm_malloc( size_t size )
89 /* likely should use ber_mem* routines */
90 return( calloc( 1, size ) );
94 #include <ac/syslog.h>
98 ldbm_db_errcall( const char *prefix, char *message )
101 syslog( LOG_INFO, "ldbm: %s %s", prefix, message );
105 int ldbm_initialize( const char* home )
110 if(ldbm_initialized++) return 1;
114 int major, minor, patch;
115 version = db_version( &major, &minor, &patch );
117 if( major != DB_VERSION_MAJOR ||
118 minor < DB_VERSION_MINOR )
123 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
126 "ldbm_initialize(): version mismatch\nexpected: %s\ngot: %s\n",
135 #if DB_VERSION_MAJOR < 3
136 #ifndef HAVE_BERKELEY_DB_THREAD
137 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
140 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
142 if( ldbm_Env == NULL ) return 1;
144 ldbm_Env->db_errcall = ldbm_db_errcall;
145 ldbm_Env->db_errpfx = "==>";
147 envFlags = DB_CREATE;
149 /* add optional flags */
151 envFlags |= DB_PRIVATE;
154 #ifdef HAVE_BERKELEY_DB_THREAD
155 envFlags |= DB_THREAD | DB_INIT_CDB | DB_INIT_MPOOL;
156 #ifdef DB_MPOOL_PRIVATE
157 envFlags |= DB_MPOOL_PRIVATE;
161 envFlags |= DB_USE_ENVIRON;
162 err = db_appinit( home, NULL, ldbm_Env, envFlags );
168 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
171 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
181 int ldbm_shutdown( void )
183 if( !ldbm_initialized ) return 1;
185 #if DB_VERSION_MAJOR < 3
186 db_appexit( ldbm_Env );
188 #ifndef HAVE_BERKELEY_DB_THREAD
189 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
196 #else /* some DB other than Berkeley V2 or greater */
198 int ldbm_initialize( const char * home )
200 if(ldbm_initialized++) return 1;
202 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
207 int ldbm_shutdown( void )
209 if( !ldbm_initialized ) return 1;
211 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
216 #endif /* HAVE_BERKELEY_DB */
219 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 3)
221 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
228 #if defined( DB_PRIVATE ) /* comment out DB_PRIVATE setting to use */
229 DB_PRIVATE | /* db_stat to view cache behavior */
231 #if defined( HAVE_BERKELEY_DB_THREAD )
236 err = db_env_create( &env, 0 );
241 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
244 syslog( LOG_INFO, "ldbm_initialize_env(): FATAL error in db_env_create() : %s\n", error );
249 env->set_errcall( env, ldbm_db_errcall );
250 env->set_errpfx( env, "==>" );
252 env->set_cachesize( env, 0, dbcachesize, 0 );
254 envFlags |= DB_INIT_MPOOL | DB_INIT_CDB | DB_USE_ENVIRON;
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 );
267 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
271 "ldbm_initialize_env(): FATAL error in dbEnv->open() : %s\n",
274 env->close( env, 0 );
282 void ldbm_shutdown_env(DB_ENV *env)
284 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)
302 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
304 /*****************************************************************
306 * use berkeley db hash or btree package *
308 *****************************************************************/
311 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
315 #if DB_VERSION_MAJOR >= 3
320 err = db_create( &ret, env, 0 );
322 (void)ret->close(ret, 0);
328 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
330 /* likely should use ber_mem* routines */
331 #if DB_VERSION_MINOR >= 3
332 ret->set_alloc( ret, ldbm_malloc, NULL, NULL );
334 ret->set_malloc( ret, ldbm_malloc );
337 /* ret->set_cachesize( ret, 0, dbcachesize, 0 ); */
339 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
343 (void)ret->close(ret, 0);
352 #elif DB_VERSION_MAJOR >= 2
355 memset( &dbinfo, '\0', sizeof( dbinfo ));
357 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
359 * BerkeleyDB 2.4 do not allow db_cachesize
360 * to be specified if an DB_ENV is.
363 /* set db_cachesize of MPOOL is NOT being used. */
364 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
365 dbinfo.db_cachesize = dbcachesize;
369 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
370 dbinfo.db_malloc = ldbm_malloc;
373 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
381 if ( DB_TYPE == DB_HASH ) {
382 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
383 hinfo.cachesize = dbcachesize;
385 } else if ( DB_TYPE == DB_BTREE ) {
386 memset( (char *) &binfo, '\0', sizeof(binfo) );
387 binfo.cachesize = dbcachesize;
394 ret = dbopen( name, rw, mode, DB_TYPE, info );
402 ldbm_close( LDBM ldbm )
405 #if DB_VERSION_MAJOR >= 3
406 ldbm->close( ldbm, 0 );
407 #elif DB_VERSION_MAJOR >= 2
408 (*ldbm->close)( ldbm, 0 );
410 (*ldbm->close)( ldbm );
416 ldbm_sync( LDBM ldbm )
419 (*ldbm->sync)( ldbm, 0 );
424 ldbm_fetch( LDBM ldbm, Datum key )
431 #if DB_VERSION_MAJOR >= 3
432 ldbm_datum_init( data );
434 data.flags = DB_DBT_MALLOC;
436 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
437 ldbm_datum_free( ldbm, data );
442 #elif DB_VERSION_MAJOR >= 2
443 ldbm_datum_init( data );
445 data.flags = DB_DBT_MALLOC;
447 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
448 ldbm_datum_free( ldbm, data );
454 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
455 /* Berkeley DB 1.85 don't malloc the data for us */
456 /* duplicate it for to ensure reentrancy */
457 data = ldbm_datum_dup( ldbm, data );
470 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
476 #if DB_VERSION_MAJOR >= 3
477 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
480 #elif 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 >= 3
503 rc = ldbm->del( ldbm, NULL, &key, 0 );
505 #elif DB_VERSION_MAJOR >= 2
506 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
509 rc = (*ldbm->del)( ldbm, &key, 0 );
511 (*ldbm->sync)( ldbm, 0 );
519 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
523 #if DB_VERSION_MAJOR >= 2
526 ldbm_datum_init( key );
527 ldbm_datum_init( data );
529 key.flags = data.flags = DB_DBT_MALLOC;
533 /* acquire a cursor for the DB */
534 # if DB_VERSION_MAJOR >= 3
535 if ( ldbm->cursor( ldbm, NULL, &dbci, 0 ) )
536 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
537 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
539 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
542 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
549 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
550 ldbm_datum_free( ldbm, data );
558 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
559 key = ldbm_datum_dup( ldbm, key );
567 #if DB_VERSION_MAJOR >= 2
577 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
581 #if DB_VERSION_MAJOR >= 2
582 ldbm_datum_init( data );
584 ldbm_datum_free( ldbm, key );
585 key.flags = data.flags = DB_DBT_MALLOC;
589 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
590 ldbm_datum_free( ldbm, data );
598 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
599 key = ldbm_datum_dup( ldbm, key );
613 ldbm_errno( LDBM ldbm )
618 /******************************************************************
620 * END Berkeley section *
622 ******************************************************************/
624 #elif defined( HAVE_GDBM )
626 #ifdef HAVE_ST_BLKSIZE
627 #include <sys/stat.h>
630 /*****************************************************************
634 *****************************************************************/
637 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
640 #ifdef HAVE_ST_BLKSIZE
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 */
794 #define mdbm_store mdbm_chain_store
795 #define mdbm_fetch mdbm_chain_fetch
796 #define mdbm_delete mdbm_chain_delete
797 #define mdbm_first mdbm_chain_first
798 #define mdbm_next mdbm_chain_next
802 #define MDBM_PG_SZ (4*1024)
804 /*****************************************************************
808 *****************************************************************/
811 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
817 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
818 name ? name : "NULL", rw, mode, dbcachesize );
822 LDBM_LOCK; /* We need locking here, this is the only non-thread
823 * safe function we have.
826 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
830 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
838 (void)mdbm_set_chain(db);
844 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
856 ldbm_close( LDBM ldbm )
859 /* Open and close are not reentrant so we need to use locks here */
863 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
872 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
882 ldbm_sync( LDBM ldbm )
884 /* XXX: Not sure if this is re-entrant need to check code, if so
885 * you can leave LOCKS out.
894 #define MAX_MDBM_RETRY 5
897 ldbm_fetch( LDBM ldbm, Datum key )
903 /* This hack is needed because MDBM does not take keys
904 * which begin with NULL when working in the chaining
911 k.key.dsize = key.dsize + 1;
912 k.key.dptr = malloc(k.key.dsize);
914 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
924 d = mdbm_fetch( ldbm, k );
928 if ( k.val.dptr != NULL ) {
932 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
934 k.val.dsize = d.dsize;
935 d = mdbm_fetch( ldbm, k );
944 }/* if ( d.dsize > 0 ) */
946 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
962 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
965 Datum int_key; /* Internal key */
969 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
970 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
977 int_key.dsize = key.dsize + 1;
978 int_key.dptr = malloc( int_key.dsize );
979 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
980 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
985 rc = mdbm_store( ldbm, int_key, data, flags );
986 if ( flags & LDBM_SYNC ) {
993 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
1008 ldbm_delete( LDBM ldbm, Datum key )
1016 int_key.dsize = key.dsize + 1;
1017 int_key.dptr = malloc(int_key.dsize);
1018 *(int_key.dptr) = 'l';
1019 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
1024 rc = mdbm_delete( ldbm, int_key );
1038 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
1043 size_t sz = MDBM_PAGE_SIZE(ldbm);
1052 in.key.dsize = sz; /* Assume first key in one pg */
1053 in.key.dptr = malloc(sz);
1055 in.val.dptr = NULL; /* Don't need data just key */
1061 out = fptr( ldbm, in );
1063 if (out.key.dsize > 0) {
1064 ret.dsize = out.key.dsize - delta;
1066 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1071 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1083 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1085 return ldbm_get_next( ldbm, mdbm_first );
1089 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1092 * don't know if this will affect the LDAP server operation
1093 * but mdbm cannot take and input key.
1096 return ldbm_get_next( ldbm, mdbm_next );
1100 ldbm_errno( LDBM ldbm )
1102 /* XXX: best we can do with current mdbm interface */
1109 #elif defined( HAVE_NDBM )
1111 /*****************************************************************
1113 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1115 *****************************************************************/
1119 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
1124 ldbm = dbm_open( name, rw, mode );
1131 ldbm_close( LDBM ldbm )
1140 ldbm_sync( LDBM ldbm )
1146 ldbm_fetch( LDBM ldbm, Datum key )
1151 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1158 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1163 rc = dbm_store( ldbm, key, data, flags );
1170 ldbm_delete( LDBM ldbm, Datum key )
1175 rc = dbm_delete( ldbm, key );
1182 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1187 d = dbm_firstkey( ldbm );
1194 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1199 d = dbm_nextkey( ldbm );
1206 ldbm_errno( LDBM ldbm )
1211 err = dbm_error( ldbm );