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))
73 /*******************************************************************
75 * Create some special functions to initialize Berkeley DB for *
76 * versions greater than 2. *
78 *******************************************************************/
79 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
82 ldbm_malloc( size_t size )
84 return( calloc( 1, size ));
88 #include <ac/syslog.h>
92 ldbm_db_errcall( const char *prefix, char *message )
95 syslog( LOG_INFO, "ldbm: %s %s", prefix, message );
99 /* a dbEnv for BERKELEYv2 */
100 DB_ENV *ldbm_Env = NULL;
102 int ldbm_initialize( const char* home )
107 if(ldbm_initialized++) return 1;
111 int major, minor, patch;
112 version = db_version( &major, &minor, &patch );
114 if( major != DB_VERSION_MAJOR ||
115 minor < DB_VERSION_MINOR )
120 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
123 "ldbm_initialize(): version mismatch\nexpected: %s\ngot: %s\n",
132 #ifndef HAVE_BERKELEY_DB_THREAD
133 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
136 #if DB_VERSION_MAJOR < 3
137 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
139 if( ldbm_Env == NULL ) return 1;
141 ldbm_Env->db_errcall = ldbm_db_errcall;
142 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 #if DB_VERSION_MAJOR >= 3
162 err = db_env_create( &ldbm_Env, 0 );
164 envFlags |= DB_USE_ENVIRON;
165 err = db_appinit( home, NULL, ldbm_Env, envFlags );
172 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
175 #if DB_VERSION_MAJOR >= 3
176 "ldbm_initialize(): FATAL error in db_env_create() : %s\n",
178 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
185 #if DB_VERSION_MAJOR > 2
186 ldbm_Env->set_errcall( ldbm_Env, ldbm_db_errcall );
187 ldbm_Env->set_errpfx( ldbm_Env, "==>" );
189 #ifdef HAVE_BERKELEY_DB_THREAD
190 envFlags |= DB_INIT_CDB | DB_INIT_MPOOL;
192 envFlags |= DB_USE_ENVIRON;
194 #if (DB_VERSION_MAJOR > 3) || (DB_VERSION_MINOR >= 1)
195 err = ldbm_Env->open( ldbm_Env, home, envFlags, 0 );
197 err = ldbm_Env->open( ldbm_Env, home, NULL, envFlags, 0 );
204 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
206 "ldbm_initialize(): FATAL error in dbEnv->open() : %s\n",
209 ldbm_Env->close( ldbm_Env, 0 );
217 int ldbm_shutdown( void )
219 if( !ldbm_initialized ) return 1;
221 #if DB_VERSION_MAJOR >= 3
222 ldbm_Env->close( ldbm_Env, 0 );
224 db_appexit( ldbm_Env );
227 #ifndef HAVE_BERKELEY_DB_THREAD
228 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
234 #else /* some DB other than Berkeley V2 or greater */
236 int ldbm_initialize( const char * home )
238 if(ldbm_initialized++) return 1;
240 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
245 int ldbm_shutdown( void )
247 if( !ldbm_initialized ) return 1;
249 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
254 #endif /* HAVE_BERKELEY_DB */
257 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
259 /*****************************************************************
261 * use berkeley db hash or btree package *
263 *****************************************************************/
266 ldbm_open( char *name, int rw, int mode, int dbcachesize )
270 #if DB_VERSION_MAJOR >= 3
275 err = db_create( &ret, ldbm_Env, 0 );
277 (void)ret->close(ret, 0);
283 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
284 ret->set_malloc( ret, ldbm_malloc );
286 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
290 (void)ret->close(ret, 0);
299 #elif DB_VERSION_MAJOR >= 2
302 memset( &dbinfo, '\0', sizeof( dbinfo ));
304 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
306 * BerkeleyDB 2.4 do not allow db_cachesize
307 * to be specified if an DB_ENV is.
310 /* set db_cachesize of MPOOL is NOT being used. */
311 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
312 dbinfo.db_cachesize = dbcachesize;
316 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
317 dbinfo.db_malloc = ldbm_malloc;
320 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
328 if ( DB_TYPE == DB_HASH ) {
329 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
330 hinfo.cachesize = dbcachesize;
332 } else if ( DB_TYPE == DB_BTREE ) {
333 memset( (char *) &binfo, '\0', sizeof(binfo) );
334 binfo.cachesize = dbcachesize;
341 ret = dbopen( name, rw, mode, DB_TYPE, info );
349 ldbm_close( LDBM ldbm )
352 #if DB_VERSION_MAJOR >= 3
353 ldbm->close( ldbm, 0 );
354 #elif DB_VERSION_MAJOR >= 2
355 (*ldbm->close)( ldbm, 0 );
357 (*ldbm->close)( ldbm );
363 ldbm_sync( LDBM ldbm )
366 (*ldbm->sync)( ldbm, 0 );
371 ldbm_fetch( LDBM ldbm, Datum key )
378 #if DB_VERSION_MAJOR >= 3
379 ldbm_datum_init( data );
381 data.flags = DB_DBT_MALLOC;
383 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
384 ldbm_datum_free( ldbm, data );
389 #elif DB_VERSION_MAJOR >= 2
390 ldbm_datum_init( data );
392 data.flags = DB_DBT_MALLOC;
394 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
395 ldbm_datum_free( ldbm, data );
401 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
402 /* Berkeley DB 1.85 don't malloc the data for us */
403 /* duplicate it for to ensure reentrancy */
404 data = ldbm_datum_dup( ldbm, data );
417 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
423 #if DB_VERSION_MAJOR >= 3
424 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
427 #elif DB_VERSION_MAJOR >= 2
428 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
431 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
434 if ( flags & LDBM_SYNC )
435 (*ldbm->sync)( ldbm, 0 );
443 ldbm_delete( LDBM ldbm, Datum key )
449 #if DB_VERSION_MAJOR >= 3
450 rc = ldbm->del( ldbm, NULL, &key, 0 );
452 #elif DB_VERSION_MAJOR >= 2
453 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
456 rc = (*ldbm->del)( ldbm, &key, 0 );
458 (*ldbm->sync)( ldbm, 0 );
466 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
470 #if DB_VERSION_MAJOR >= 2
473 ldbm_datum_init( key );
474 ldbm_datum_init( data );
476 key.flags = data.flags = DB_DBT_MALLOC;
480 /* acquire a cursor for the DB */
481 # if DB_VERSION_MAJOR >= 3
482 if ( ldbm->cursor( ldbm, NULL, &dbci, 0 ) )
483 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
484 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
486 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
489 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
496 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
497 ldbm_datum_free( ldbm, data );
505 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
506 key = ldbm_datum_dup( ldbm, key );
514 #if DB_VERSION_MAJOR >= 2
524 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
528 #if DB_VERSION_MAJOR >= 2
529 ldbm_datum_init( data );
531 ldbm_datum_free( ldbm, key );
532 key.flags = data.flags = DB_DBT_MALLOC;
536 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
537 ldbm_datum_free( ldbm, data );
545 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
546 key = ldbm_datum_dup( ldbm, key );
560 ldbm_errno( LDBM ldbm )
565 /******************************************************************
567 * END Berkeley section *
569 ******************************************************************/
571 #elif defined( HAVE_GDBM )
573 #ifdef HAVE_ST_BLKSIZE
574 #include <sys/stat.h>
577 /*****************************************************************
581 *****************************************************************/
584 ldbm_open( char *name, int rw, int mode, int dbcachesize )
587 #ifdef HAVE_ST_BLKSIZE
593 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
598 #ifdef HAVE_ST_BLKSIZE
599 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
600 dbcachesize /= st.st_blksize;
601 if( dbcachesize == 0 ) dbcachesize = 1;
602 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
605 if ( dbcachesize > 0 ) {
607 if( dbcachesize == 0 ) dbcachesize = 1;
608 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
618 ldbm_close( LDBM ldbm )
626 ldbm_sync( LDBM ldbm )
634 ldbm_fetch( LDBM ldbm, Datum key )
639 d = gdbm_fetch( ldbm, key );
646 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
651 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
652 if ( flags & LDBM_SYNC )
660 ldbm_delete( LDBM ldbm, Datum key )
665 rc = gdbm_delete( ldbm, key );
673 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
678 d = gdbm_firstkey( ldbm );
681 if ( d.dptr != NULL ) {
682 *dbcp = (Datum *) malloc( sizeof( Datum ) );
683 **dbcp = ldbm_datum_dup( ldbm, d );
690 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
695 d = gdbm_nextkey( ldbm, *dbcp );
698 ldbm_datum_free( ldbm, *dbcp );
700 if ( d.dptr != NULL ) {
701 *dbcp = ldbm_datum_dup( ldbm, d );
710 ldbm_errno( LDBM ldbm )
723 /* MMAPED DBM HASHING DATABASE */
725 #include <ac/string.h>
727 /* #define MDBM_DEBUG */
734 /* #define MDBM_CHAIN */
741 #define mdbm_store mdbm_chain_store
742 #define mdbm_fetch mdbm_chain_fetch
743 #define mdbm_delete mdbm_chain_delete
744 #define mdbm_first mdbm_chain_first
745 #define mdbm_next mdbm_chain_next
749 #define MDBM_PG_SZ (4*1024)
751 /*****************************************************************
755 *****************************************************************/
758 ldbm_open( char *name, int rw, int mode, int dbcachesize )
764 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
765 name ? name : "NULL", rw, mode, dbcachesize );
769 LDBM_LOCK; /* We need locking here, this is the only non-thread
770 * safe function we have.
773 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
777 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
785 (void)mdbm_set_chain(db);
791 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
803 ldbm_close( LDBM ldbm )
806 /* Open and close are not reentrant so we need to use locks here */
810 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
819 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
829 ldbm_sync( LDBM ldbm )
831 /* XXX: Not sure if this is re-entrant need to check code, if so
832 * you can leave LOCKS out.
841 #define MAX_MDBM_RETRY 5
844 ldbm_fetch( LDBM ldbm, Datum key )
850 /* This hack is needed because MDBM does not take keys
851 * which begin with NULL when working in the chaining
858 k.key.dsize = key.dsize + 1;
859 k.key.dptr = malloc(k.key.dsize);
861 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
871 d = mdbm_fetch( ldbm, k );
875 if ( k.val.dptr != NULL ) {
879 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
881 k.val.dsize = d.dsize;
882 d = mdbm_fetch( ldbm, k );
891 }/* if ( d.dsize > 0 ) */
893 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
909 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
912 Datum int_key; /* Internal key */
916 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
917 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
924 int_key.dsize = key.dsize + 1;
925 int_key.dptr = malloc( int_key.dsize );
926 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
927 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
932 rc = mdbm_store( ldbm, int_key, data, flags );
933 if ( flags & LDBM_SYNC ) {
940 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
955 ldbm_delete( LDBM ldbm, Datum key )
963 int_key.dsize = key.dsize + 1;
964 int_key.dptr = malloc(int_key.dsize);
965 *(int_key.dptr) = 'l';
966 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
971 rc = mdbm_delete( ldbm, int_key );
985 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
990 size_t sz = MDBM_PAGE_SIZE(ldbm);
999 in.key.dsize = sz; /* Assume first key in one pg */
1000 in.key.dptr = malloc(sz);
1002 in.val.dptr = NULL; /* Don't need data just key */
1008 out = fptr( ldbm, in );
1010 if (out.key.dsize > 0) {
1011 ret.dsize = out.key.dsize - delta;
1013 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1018 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1030 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1032 return ldbm_get_next( ldbm, mdbm_first );
1036 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1039 * don't know if this will affect the LDAP server operation
1040 * but mdbm cannot take and input key.
1043 return ldbm_get_next( ldbm, mdbm_next );
1047 ldbm_errno( LDBM ldbm )
1049 /* XXX: best we can do with current mdbm interface */
1056 #elif defined( HAVE_NDBM )
1058 /*****************************************************************
1060 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1062 *****************************************************************/
1066 ldbm_open( char *name, int rw, int mode, int dbcachesize )
1071 ldbm = dbm_open( name, rw, mode );
1078 ldbm_close( LDBM ldbm )
1087 ldbm_sync( LDBM ldbm )
1093 ldbm_fetch( LDBM ldbm, Datum key )
1098 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1105 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1110 rc = dbm_store( ldbm, key, data, flags );
1117 ldbm_delete( LDBM ldbm, Datum key )
1122 rc = dbm_delete( ldbm, key );
1129 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1134 d = dbm_firstkey( ldbm );
1141 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1146 d = dbm_nextkey( ldbm );
1153 ldbm_errno( LDBM ldbm )
1158 err = dbm_error( ldbm );