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 return( calloc( 1, size ));
93 #include <ac/syslog.h>
97 ldbm_db_errcall( const char *prefix, char *message )
100 syslog( LOG_INFO, "ldbm: %s %s", prefix, message );
104 #if DB_VERSION_MAJOR < 3
106 int ldbm_initialize( const char* home )
111 if(ldbm_initialized++) return 1;
115 int major, minor, patch;
116 version = db_version( &major, &minor, &patch );
118 if( major != DB_VERSION_MAJOR ||
119 minor < DB_VERSION_MINOR )
124 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
127 "ldbm_initialize(): version mismatch\nexpected: %s\ngot: %s\n",
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",
180 int ldbm_shutdown( void )
182 if( !ldbm_initialized ) return 1;
184 db_appexit( ldbm_Env );
186 #ifndef HAVE_BERKELEY_DB_THREAD
187 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
193 #else /* Berkeley v3 or greater */
196 int ldbm_initialize( const char * home )
198 /* v3 uses ldbm_initialize_env */
203 int ldbm_shutdown( void )
213 #else /* some DB other than Berkeley V2 or greater */
215 int ldbm_initialize( const char * home )
217 if(ldbm_initialized++) return 1;
219 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
224 int ldbm_shutdown( void )
226 if( !ldbm_initialized ) return 1;
228 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
233 #endif /* HAVE_BERKELEY_DB */
236 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 3)
239 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
246 #if defined( DB_PRIVATE ) /* comment out DB_PRIVATE setting to use */
247 DB_PRIVATE | /* db_stat to view cache behavior */
249 #if defined( HAVE_BERKELEY_DB_THREAD )
254 err = db_env_create( &env, 0 );
259 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
262 syslog( LOG_INFO, "ldbm_initialize_env(): FATAL error in db_env_create() : %s\n", error );
267 env->set_errcall( env, ldbm_db_errcall );
268 env->set_errpfx( env, "==>" );
270 env->set_cachesize( env, 0, dbcachesize, 0 );
272 envFlags |= DB_INIT_MPOOL | DB_INIT_CDB | DB_USE_ENVIRON;
274 err = env->open( env, home, envFlags, 0 );
280 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
284 "ldbm_initialize_env(): FATAL error in dbEnv->open() : %s\n",
287 env->close( env, 0 );
295 void ldbm_shutdown_env(DB_ENV *env)
297 env->close( env, 0 );
303 DB_ENV *ldbm_initialize_env(const char *home, int dbcachesize, int *envdirok)
308 void ldbm_shutdown_env(DB_ENV *env)
316 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
318 /*****************************************************************
320 * use berkeley db hash or btree package *
322 *****************************************************************/
325 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
329 #if DB_VERSION_MAJOR >= 3
334 err = db_create( &ret, env, 0 );
336 (void)ret->close(ret, 0);
342 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
343 ret->set_malloc( ret, ldbm_malloc );
344 /* ret->set_cachesize( ret, 0, dbcachesize, 0 ); */
346 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
350 (void)ret->close(ret, 0);
359 #elif DB_VERSION_MAJOR >= 2
362 memset( &dbinfo, '\0', sizeof( dbinfo ));
364 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
366 * BerkeleyDB 2.4 do not allow db_cachesize
367 * to be specified if an DB_ENV is.
370 /* set db_cachesize of MPOOL is NOT being used. */
371 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
372 dbinfo.db_cachesize = dbcachesize;
376 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
377 dbinfo.db_malloc = ldbm_malloc;
380 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
388 if ( DB_TYPE == DB_HASH ) {
389 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
390 hinfo.cachesize = dbcachesize;
392 } else if ( DB_TYPE == DB_BTREE ) {
393 memset( (char *) &binfo, '\0', sizeof(binfo) );
394 binfo.cachesize = dbcachesize;
401 ret = dbopen( name, rw, mode, DB_TYPE, info );
409 ldbm_close( LDBM ldbm )
412 #if DB_VERSION_MAJOR >= 3
413 ldbm->close( ldbm, 0 );
414 #elif DB_VERSION_MAJOR >= 2
415 (*ldbm->close)( ldbm, 0 );
417 (*ldbm->close)( ldbm );
423 ldbm_sync( LDBM ldbm )
426 (*ldbm->sync)( ldbm, 0 );
431 ldbm_fetch( LDBM ldbm, Datum key )
438 #if DB_VERSION_MAJOR >= 3
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 #elif DB_VERSION_MAJOR >= 2
450 ldbm_datum_init( data );
452 data.flags = DB_DBT_MALLOC;
454 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
455 ldbm_datum_free( ldbm, data );
461 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
462 /* Berkeley DB 1.85 don't malloc the data for us */
463 /* duplicate it for to ensure reentrancy */
464 data = ldbm_datum_dup( ldbm, data );
477 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
483 #if DB_VERSION_MAJOR >= 3
484 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
487 #elif DB_VERSION_MAJOR >= 2
488 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
491 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
494 if ( flags & LDBM_SYNC )
495 (*ldbm->sync)( ldbm, 0 );
503 ldbm_delete( LDBM ldbm, Datum key )
509 #if DB_VERSION_MAJOR >= 3
510 rc = ldbm->del( ldbm, NULL, &key, 0 );
512 #elif DB_VERSION_MAJOR >= 2
513 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
516 rc = (*ldbm->del)( ldbm, &key, 0 );
518 (*ldbm->sync)( ldbm, 0 );
526 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
530 #if DB_VERSION_MAJOR >= 2
533 ldbm_datum_init( key );
534 ldbm_datum_init( data );
536 key.flags = data.flags = DB_DBT_MALLOC;
540 /* acquire a cursor for the DB */
541 # if DB_VERSION_MAJOR >= 3
542 if ( ldbm->cursor( ldbm, NULL, &dbci, 0 ) )
543 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
544 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
546 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
549 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
556 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
557 ldbm_datum_free( ldbm, data );
565 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
566 key = ldbm_datum_dup( ldbm, key );
574 #if DB_VERSION_MAJOR >= 2
584 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
588 #if DB_VERSION_MAJOR >= 2
589 ldbm_datum_init( data );
591 ldbm_datum_free( ldbm, key );
592 key.flags = data.flags = DB_DBT_MALLOC;
596 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
597 ldbm_datum_free( ldbm, data );
605 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
606 key = ldbm_datum_dup( ldbm, key );
620 ldbm_errno( LDBM ldbm )
625 /******************************************************************
627 * END Berkeley section *
629 ******************************************************************/
631 #elif defined( HAVE_GDBM )
633 #ifdef HAVE_ST_BLKSIZE
634 #include <sys/stat.h>
637 /*****************************************************************
641 *****************************************************************/
644 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
647 #ifdef HAVE_ST_BLKSIZE
653 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
658 #ifdef HAVE_ST_BLKSIZE
659 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
660 dbcachesize /= st.st_blksize;
661 if( dbcachesize == 0 ) dbcachesize = 1;
662 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
665 if ( dbcachesize > 0 ) {
667 if( dbcachesize == 0 ) dbcachesize = 1;
668 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
678 ldbm_close( LDBM ldbm )
686 ldbm_sync( LDBM ldbm )
694 ldbm_fetch( LDBM ldbm, Datum key )
699 d = gdbm_fetch( ldbm, key );
706 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
711 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
712 if ( flags & LDBM_SYNC )
720 ldbm_delete( LDBM ldbm, Datum key )
725 rc = gdbm_delete( ldbm, key );
733 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
738 d = gdbm_firstkey( ldbm );
741 if ( d.dptr != NULL ) {
742 *dbcp = (Datum *) malloc( sizeof( Datum ) );
743 **dbcp = ldbm_datum_dup( ldbm, d );
750 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
755 d = gdbm_nextkey( ldbm, *dbcp );
758 ldbm_datum_free( ldbm, *dbcp );
760 if ( d.dptr != NULL ) {
761 *dbcp = ldbm_datum_dup( ldbm, d );
770 ldbm_errno( LDBM ldbm )
783 /* MMAPED DBM HASHING DATABASE */
785 #include <ac/string.h>
787 /* #define MDBM_DEBUG */
794 /* #define MDBM_CHAIN */
801 #define mdbm_store mdbm_chain_store
802 #define mdbm_fetch mdbm_chain_fetch
803 #define mdbm_delete mdbm_chain_delete
804 #define mdbm_first mdbm_chain_first
805 #define mdbm_next mdbm_chain_next
809 #define MDBM_PG_SZ (4*1024)
811 /*****************************************************************
815 *****************************************************************/
818 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
824 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
825 name ? name : "NULL", rw, mode, dbcachesize );
829 LDBM_LOCK; /* We need locking here, this is the only non-thread
830 * safe function we have.
833 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
837 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
845 (void)mdbm_set_chain(db);
851 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
863 ldbm_close( LDBM ldbm )
866 /* Open and close are not reentrant so we need to use locks here */
870 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
879 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
889 ldbm_sync( LDBM ldbm )
891 /* XXX: Not sure if this is re-entrant need to check code, if so
892 * you can leave LOCKS out.
901 #define MAX_MDBM_RETRY 5
904 ldbm_fetch( LDBM ldbm, Datum key )
910 /* This hack is needed because MDBM does not take keys
911 * which begin with NULL when working in the chaining
918 k.key.dsize = key.dsize + 1;
919 k.key.dptr = malloc(k.key.dsize);
921 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
931 d = mdbm_fetch( ldbm, k );
935 if ( k.val.dptr != NULL ) {
939 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
941 k.val.dsize = d.dsize;
942 d = mdbm_fetch( ldbm, k );
951 }/* if ( d.dsize > 0 ) */
953 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
969 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
972 Datum int_key; /* Internal key */
976 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
977 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
984 int_key.dsize = key.dsize + 1;
985 int_key.dptr = malloc( int_key.dsize );
986 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
987 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
992 rc = mdbm_store( ldbm, int_key, data, flags );
993 if ( flags & LDBM_SYNC ) {
1000 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
1015 ldbm_delete( LDBM ldbm, Datum key )
1023 int_key.dsize = key.dsize + 1;
1024 int_key.dptr = malloc(int_key.dsize);
1025 *(int_key.dptr) = 'l';
1026 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
1031 rc = mdbm_delete( ldbm, int_key );
1045 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
1050 size_t sz = MDBM_PAGE_SIZE(ldbm);
1059 in.key.dsize = sz; /* Assume first key in one pg */
1060 in.key.dptr = malloc(sz);
1062 in.val.dptr = NULL; /* Don't need data just key */
1068 out = fptr( ldbm, in );
1070 if (out.key.dsize > 0) {
1071 ret.dsize = out.key.dsize - delta;
1073 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
1078 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1090 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1092 return ldbm_get_next( ldbm, mdbm_first );
1096 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1099 * don't know if this will affect the LDAP server operation
1100 * but mdbm cannot take and input key.
1103 return ldbm_get_next( ldbm, mdbm_next );
1107 ldbm_errno( LDBM ldbm )
1109 /* XXX: best we can do with current mdbm interface */
1116 #elif defined( HAVE_NDBM )
1118 /*****************************************************************
1120 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1122 *****************************************************************/
1126 ldbm_open( DB_ENV *env, char *name, int rw, int mode, int dbcachesize )
1131 ldbm = dbm_open( name, rw, mode );
1138 ldbm_close( LDBM ldbm )
1147 ldbm_sync( LDBM ldbm )
1153 ldbm_fetch( LDBM ldbm, Datum key )
1158 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1165 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1170 rc = dbm_store( ldbm, key, data, flags );
1177 ldbm_delete( LDBM ldbm, Datum key )
1182 rc = dbm_delete( ldbm, key );
1189 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1194 d = dbm_firstkey( ldbm );
1201 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1206 d = dbm_nextkey( ldbm );
1213 ldbm_errno( LDBM ldbm )
1218 err = dbm_error( ldbm );