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;
53 if ( (dup.dptr = (char *) malloc( data.dsize )) != NULL )
54 AC_MEMCPY( dup.dptr, data.dptr, data.dsize );
59 static int ldbm_initialized = 0;
61 #ifdef HAVE_BERKELEY_DB_THREAD
62 #define LDBM_LOCK ((void)0)
63 #define LDBM_UNLOCK ((void)0)
66 /* Only DB2 or DB3 with DB_THREAD is thread-free */
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))
75 /*******************************************************************
77 * Create some special functions to initialize Berkeley DB for *
78 * versions greater than 2. *
80 *******************************************************************/
81 #if defined( HAVE_BERKELEY_DB ) && (DB_VERSION_MAJOR >= 2)
84 ldbm_malloc( size_t size )
86 return( calloc( 1, size ));
90 #include <ac/syslog.h>
94 ldbm_db_errcall( const char *prefix, char *message )
97 syslog( LOG_INFO, "ldbm: %s %s", prefix, message );
101 /* a dbEnv for BERKELEYv2 */
102 DB_ENV *ldbm_Env = NULL;
104 int ldbm_initialize( const char* home )
109 if(ldbm_initialized++) return 1;
111 #if DB_VERSION_MAJOR < 3
112 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
114 if( ldbm_Env == NULL ) return 1;
116 ldbm_Env->db_errcall = ldbm_db_errcall;
117 ldbm_Env->db_errpfx = "==>";
123 #if defined( DB_PRIVATE )
126 #if defined( HAVE_BERKELEY_DB_THREAD )
131 #if DB_VERSION_MAJOR >= 3
132 err = db_env_create( &ldbm_Env, 0 );
134 envFlags |= DB_USE_ENVIRON;
135 err = db_appinit( home, NULL, ldbm_Env, envFlags );
141 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
145 #if DB_VERSION_MAJOR >= 3
146 "ldbm_initialize(): FATAL error in db_env_create() : %s\n",
148 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
155 #if DB_VERSION_MAJOR > 2
156 ldbm_Env->set_errcall( ldbm_Env, ldbm_db_errcall );
157 ldbm_Env->set_errpfx( ldbm_Env, "==>" );
159 envFlags |= DB_INIT_MPOOL | DB_USE_ENVIRON;
161 #if (DB_VERSION_MAJOR > 3) || (DB_VERSION_MINOR >= 1)
162 err = ldbm_Env->open( ldbm_Env, home, envFlags, 0 );
164 err = ldbm_Env->open( ldbm_Env, home, NULL, envFlags, 0 );
170 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
174 "ldbm_initialize(): FATAL error in dbEnv->open() : %s\n",
177 ldbm_Env->close( ldbm_Env, 0 );
185 int ldbm_shutdown( void )
187 if( !ldbm_initialized ) return 1;
189 #if DB_VERSION_MAJOR >= 3
190 ldbm_Env->close( ldbm_Env, 0 );
192 db_appexit( ldbm_Env );
198 #else /* some DB other than Berkeley V2 or greater */
200 int ldbm_initialize( const char * home )
202 if(ldbm_initialized++) return 1;
204 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
209 int ldbm_shutdown( void )
211 if( !ldbm_initialized ) return 1;
213 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
218 #endif /* HAVE_BERKELEY_DB */
221 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
223 /*****************************************************************
225 * use berkeley db hash or btree package *
227 *****************************************************************/
230 ldbm_open( char *name, int rw, int mode, int dbcachesize )
234 #if DB_VERSION_MAJOR >= 3
237 err = db_create( &ret, ldbm_Env, 0 );
242 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
244 (void)ret->close(ret, 0);
248 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
249 ret->set_malloc( ret, ldbm_malloc );
250 ret->set_cachesize( ret, 0, dbcachesize, 0 );
251 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
257 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
259 (void)ret->close(ret, 0);
263 #elif DB_VERSION_MAJOR >= 2
266 memset( &dbinfo, '\0', sizeof( dbinfo ));
268 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
270 * BerkeleyDB 2.4 do not allow db_cachesize
271 * to be specified if an DB_ENV is.
274 /* set db_cachesize of MPOOL is NOT being used. */
275 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL ))
276 dbinfo.db_cachesize = dbcachesize;
279 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
280 dbinfo.db_malloc = ldbm_malloc;
283 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
291 if ( DB_TYPE == DB_HASH ) {
292 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
293 hinfo.cachesize = dbcachesize;
295 } else if ( DB_TYPE == DB_BTREE ) {
296 memset( (char *) &binfo, '\0', sizeof(binfo) );
297 binfo.cachesize = dbcachesize;
304 ret = dbopen( name, rw, mode, DB_TYPE, info );
313 ldbm_close( LDBM ldbm )
316 #if DB_VERSION_MAJOR >= 3
317 ldbm->close( ldbm, 0 );
318 #elif DB_VERSION_MAJOR >= 2
319 (*ldbm->close)( ldbm, 0 );
321 (*ldbm->close)( ldbm );
327 ldbm_sync( LDBM ldbm )
330 (*ldbm->sync)( ldbm, 0 );
335 ldbm_fetch( LDBM ldbm, Datum key )
341 #if DB_VERSION_MAJOR >= 3
342 ldbm_datum_init( data );
344 data.flags = DB_DBT_MALLOC;
346 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
347 ldbm_datum_free( ldbm, data );
349 #elif DB_VERSION_MAJOR >= 2
350 ldbm_datum_init( data );
352 data.flags = DB_DBT_MALLOC;
354 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
355 ldbm_datum_free( ldbm, data );
357 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
358 /* Berkeley DB 1.85 don't malloc the data for us */
359 /* duplicate it for to ensure reentrancy */
360 data = ldbm_datum_dup( ldbm, data );
373 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
379 #if DB_VERSION_MAJOR >= 3
380 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
385 sprintf( error, "%s (%d)\n", STRERROR( rc ), rc );
389 #elif DB_VERSION_MAJOR >= 2
390 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
393 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
396 if ( flags & LDBM_SYNC )
397 (*ldbm->sync)( ldbm, 0 );
405 ldbm_delete( LDBM ldbm, Datum key )
411 #if DB_VERSION_MAJOR >= 3
412 rc = ldbm->del( ldbm, NULL, &key, 0 );
414 #elif DB_VERSION_MAJOR >= 2
415 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
418 rc = (*ldbm->del)( ldbm, &key, 0 );
420 (*ldbm->sync)( ldbm, 0 );
428 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
432 #if DB_VERSION_MAJOR >= 2
435 ldbm_datum_init( key );
436 ldbm_datum_init( data );
438 key.flags = data.flags = DB_DBT_MALLOC;
442 /* acquire a cursor for the DB */
443 # if DB_VERSION_MAJOR >= 3
444 if ( ldbm->cursor( ldbm, NULL, &dbci, 0 ) )
445 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
446 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
448 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
451 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
458 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
459 ldbm_datum_free( ldbm, data );
467 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
468 key = ldbm_datum_dup( ldbm, key );
476 #if DB_VERSION_MAJOR >= 2
486 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
490 #if DB_VERSION_MAJOR >= 2
491 ldbm_datum_init( data );
493 ldbm_datum_free( ldbm, key );
494 key.flags = data.flags = DB_DBT_MALLOC;
498 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
499 ldbm_datum_free( ldbm, data );
507 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
508 key = ldbm_datum_dup( ldbm, key );
522 ldbm_errno( LDBM ldbm )
527 /******************************************************************
529 * END Berkeley section *
531 ******************************************************************/
533 #elif defined( HAVE_GDBM )
535 #ifdef HAVE_ST_BLKSIZE
536 #include <sys/stat.h>
539 /*****************************************************************
543 *****************************************************************/
546 ldbm_open( char *name, int rw, int mode, int dbcachesize )
549 #ifdef HAVE_ST_BLKSIZE
555 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
560 #ifdef HAVE_ST_BLKSIZE
561 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
562 dbcachesize /= st.st_blksize;
563 if( dbcachesize == 0 ) dbcachesize = 1;
564 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
567 if ( dbcachesize > 0 ) {
569 if( dbcachesize == 0 ) dbcachesize = 1;
570 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
580 ldbm_close( LDBM ldbm )
588 ldbm_sync( LDBM ldbm )
596 ldbm_fetch( LDBM ldbm, Datum key )
601 d = gdbm_fetch( ldbm, key );
608 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
613 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
614 if ( flags & LDBM_SYNC )
622 ldbm_delete( LDBM ldbm, Datum key )
627 rc = gdbm_delete( ldbm, key );
635 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
640 d = gdbm_firstkey( ldbm );
643 if ( d.dptr != NULL ) {
644 *dbcp = (Datum *) malloc( sizeof( Datum ) );
645 **dbcp = ldbm_datum_dup( ldbm, d );
652 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
657 d = gdbm_nextkey( ldbm, *dbcp );
660 ldbm_datum_free( ldbm, *dbcp );
662 if ( d.dptr != NULL ) {
663 *dbcp = ldbm_datum_dup( ldbm, d );
672 ldbm_errno( LDBM ldbm )
685 /* MMAPED DBM HASHING DATABASE */
687 #include <ac/string.h>
689 /* #define MDBM_DEBUG */
696 /* #define MDBM_CHAIN */
703 #define mdbm_store mdbm_chain_store
704 #define mdbm_fetch mdbm_chain_fetch
705 #define mdbm_delete mdbm_chain_delete
706 #define mdbm_first mdbm_chain_first
707 #define mdbm_next mdbm_chain_next
711 #define MDBM_PG_SZ (4*1024)
713 /*****************************************************************
717 *****************************************************************/
720 ldbm_open( char *name, int rw, int mode, int dbcachesize )
726 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
727 name ? name : "NULL", rw, mode, dbcachesize );
731 LDBM_LOCK; /* We need locking here, this is the only non-thread
732 * safe function we have.
735 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
739 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
747 (void)mdbm_set_chain(db);
753 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
765 ldbm_close( LDBM ldbm )
768 /* Open and close are not reentrant so we need to use locks here */
772 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
781 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
791 ldbm_sync( LDBM ldbm )
794 /* XXX: Not sure if this is re-entrant need to check code, if so
795 * you can leave LOCKS out.
805 #define MAX_MDBM_RETRY 5
808 ldbm_fetch( LDBM ldbm, Datum key )
814 /* This hack is needed because MDBM does not take keys
815 * which begin with NULL when working in the chaining
822 k.key.dsize = key.dsize + 1;
823 k.key.dptr = malloc(k.key.dsize);
825 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
835 d = mdbm_fetch( ldbm, k );
839 if ( k.val.dptr != NULL ) {
845 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
847 k.val.dsize = d.dsize;
848 d = mdbm_fetch( ldbm, k );
857 }/* if ( d.dsize > 0 ) */
859 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
875 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
878 Datum int_key; /* Internal key */
882 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
883 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
890 int_key.dsize = key.dsize + 1;
891 int_key.dptr = malloc( int_key.dsize );
892 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
893 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
898 rc = mdbm_store( ldbm, int_key, data, flags );
899 if ( flags & LDBM_SYNC ) {
906 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
921 ldbm_delete( LDBM ldbm, Datum key )
929 int_key.dsize = key.dsize + 1;
930 int_key.dptr = malloc(int_key.dsize);
931 *(int_key.dptr) = 'l';
932 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
937 rc = mdbm_delete( ldbm, int_key );
952 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
958 size_t sz = MDBM_PAGE_SIZE(ldbm);
967 in.key.dsize = sz; /* Assume first key in one pg */
968 in.key.dptr = malloc(sz);
970 in.val.dptr = NULL; /* Don't need data just key */
976 out = fptr( ldbm, in );
978 if (out.key.dsize > 0) {
980 ret.dsize = out.key.dsize - delta;
981 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
988 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1007 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1010 return ldbm_get_next( ldbm, mdbm_first );
1018 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1022 * don't know if this will affect the LDAP server opertaion
1023 * but mdbm cannot take and input key.
1026 return ldbm_get_next( ldbm, mdbm_next );
1031 ldbm_errno( LDBM ldbm )
1033 /* XXX: best we can do with current mdbm interface */
1041 #elif defined( HAVE_NDBM )
1043 /*****************************************************************
1045 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1047 *****************************************************************/
1051 ldbm_open( char *name, int rw, int mode, int dbcachesize )
1056 ldbm = dbm_open( name, rw, mode );
1063 ldbm_close( LDBM ldbm )
1072 ldbm_sync( LDBM ldbm )
1078 ldbm_fetch( LDBM ldbm, Datum key )
1083 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1090 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1095 rc = dbm_store( ldbm, key, data, flags );
1102 ldbm_delete( LDBM ldbm, Datum key )
1107 rc = dbm_delete( ldbm, key );
1114 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1119 d = dbm_firstkey( ldbm );
1126 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1131 d = dbm_nextkey( ldbm );
1138 ldbm_errno( LDBM ldbm )
1143 err = dbm_error( ldbm );