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)
85 ldbm_malloc( size_t size )
87 return( calloc( 1, size ));
91 #include <ac/syslog.h>
95 ldbm_db_errcall( const char *prefix, char *message )
98 syslog( LOG_INFO, "ldbm_db_errcall(): %s %s", prefix, message );
102 /* a dbEnv for BERKELEYv2 */
103 DB_ENV *ldbm_Env = NULL;
105 int ldbm_initialize( void )
110 if(ldbm_initialized++) return 1;
112 #if DB_VERSION_MAJOR < 3
113 ldbm_Env = calloc( 1, sizeof( DB_ENV ));
115 if( ldbm_Env == NULL ) return 1;
117 ldbm_Env->db_errcall = ldbm_db_errcall;
118 ldbm_Env->db_errpfx = "==>";
124 #if defined( HAVE_BERKELEY_DB_THREAD )
129 #if DB_VERSION_MAJOR >= 3
130 err = db_env_create( &ldbm_Env, 0 );
131 #elif DB_VERSION_MAJOR >= 2
132 err = db_appinit( NULL, NULL, ldbm_Env, envFlags );
138 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
142 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
148 #if DB_VERSION_MAJOR > 2
149 ldbm_Env->set_errcall( ldbm_Env, ldbm_db_errcall );
150 ldbm_Env->set_errpfx( ldbm_Env, "==>" );
152 envFlags |= DB_INIT_MPOOL;
154 #if (DB_VERSION_MAJOR > 3) || (DB_VERSION_MINOR >= 1)
155 err = ldbm_Env->open( ldbm_Env, NULL, envFlags, 0 );
157 err = ldbm_Env->open( ldbm_Env, NULL, NULL, envFlags, 0 );
163 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
167 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
170 ldbm_Env->close( ldbm_Env, 0 );
178 int ldbm_shutdown( void )
180 if( !ldbm_initialized ) return 1;
182 #if DB_VERSION_MAJOR >= 3
183 ldbm_Env->close( ldbm_Env, 0 );
185 db_appexit( ldbm_Env );
191 #else /* some DB other than Berkeley V2 or greater */
193 int ldbm_initialize( void )
195 if(ldbm_initialized++) return 1;
197 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
202 int ldbm_shutdown( void )
204 if( !ldbm_initialized ) return 1;
206 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
211 #endif /* ifdef HAVE_BERKELEY_DB */
214 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
216 /*****************************************************************
218 * use berkeley db hash or btree package *
220 *****************************************************************/
223 ldbm_open( char *name, int rw, int mode, int dbcachesize )
227 #if DB_VERSION_MAJOR >= 3
230 err = db_create( &ret, ldbm_Env, 0 );
235 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
237 (void)ret->close(ret, 0);
241 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
242 ret->set_malloc( ret, ldbm_malloc );
243 ret->set_cachesize( ret, 0, dbcachesize, 0 );
244 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
250 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
252 (void)ret->close(ret, 0);
256 #elif DB_VERSION_MAJOR >= 2
259 memset( &dbinfo, '\0', sizeof( dbinfo ));
261 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
263 * BerkeleyDB 2.4 do not allow db_cachesize
264 * to be specified if an DB_ENV is.
267 /* set db_cachesize of MPOOL is NOT being used. */
268 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL ))
269 dbinfo.db_cachesize = dbcachesize;
272 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
273 dbinfo.db_malloc = ldbm_malloc;
276 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
284 if ( DB_TYPE == DB_HASH ) {
285 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
286 hinfo.cachesize = dbcachesize;
288 } else if ( DB_TYPE == DB_BTREE ) {
289 memset( (char *) &binfo, '\0', sizeof(binfo) );
290 binfo.cachesize = dbcachesize;
297 ret = dbopen( name, rw, mode, DB_TYPE, info );
306 ldbm_close( LDBM ldbm )
309 #if DB_VERSION_MAJOR >= 3
310 ldbm->close( ldbm, 0 );
311 #elif DB_VERSION_MAJOR >= 2
312 (*ldbm->close)( ldbm, 0 );
314 (*ldbm->close)( ldbm );
320 ldbm_sync( LDBM ldbm )
323 (*ldbm->sync)( ldbm, 0 );
328 ldbm_fetch( LDBM ldbm, Datum key )
334 #if DB_VERSION_MAJOR >= 3
335 ldbm_datum_init( data );
337 data.flags = DB_DBT_MALLOC;
339 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
340 ldbm_datum_free( ldbm, data );
342 #elif DB_VERSION_MAJOR >= 2
343 ldbm_datum_init( data );
345 data.flags = DB_DBT_MALLOC;
347 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
348 ldbm_datum_free( ldbm, data );
350 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
351 /* Berkeley DB 1.85 don't malloc the data for us */
352 /* duplicate it for to ensure reentrancy */
353 data = ldbm_datum_dup( ldbm, data );
366 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
372 #if DB_VERSION_MAJOR >= 3
373 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
378 sprintf( error, "%s (%d)\n", STRERROR( rc ), rc );
382 #elif DB_VERSION_MAJOR >= 2
383 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
386 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
389 if ( flags & LDBM_SYNC )
390 (*ldbm->sync)( ldbm, 0 );
398 ldbm_delete( LDBM ldbm, Datum key )
404 #if DB_VERSION_MAJOR >= 3
405 rc = ldbm->del( ldbm, NULL, &key, 0 );
407 #elif DB_VERSION_MAJOR >= 2
408 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
411 rc = (*ldbm->del)( ldbm, &key, 0 );
413 (*ldbm->sync)( ldbm, 0 );
421 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
425 #if DB_VERSION_MAJOR >= 2
428 ldbm_datum_init( key );
429 ldbm_datum_init( data );
431 key.flags = data.flags = DB_DBT_MALLOC;
435 /* acquire a cursor for the DB */
436 # if DB_VERSION_MAJOR >= 3
437 if ( ldbm->cursor( ldbm, NULL, &dbci, 0 ) )
438 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
439 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
441 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
444 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
451 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
452 ldbm_datum_free( ldbm, data );
460 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
461 key = ldbm_datum_dup( ldbm, key );
469 #if DB_VERSION_MAJOR >= 2
479 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
483 #if DB_VERSION_MAJOR >= 2
484 ldbm_datum_init( data );
486 ldbm_datum_free( ldbm, key );
487 key.flags = data.flags = DB_DBT_MALLOC;
491 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
492 ldbm_datum_free( ldbm, data );
500 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
501 key = ldbm_datum_dup( ldbm, key );
515 ldbm_errno( LDBM ldbm )
520 /******************************************************************
522 * END Berkeley section *
524 ******************************************************************/
526 #elif defined( HAVE_GDBM )
528 #ifdef HAVE_ST_BLKSIZE
529 #include <sys/stat.h>
532 /*****************************************************************
536 *****************************************************************/
539 ldbm_open( char *name, int rw, int mode, int dbcachesize )
542 #ifdef HAVE_ST_BLKSIZE
548 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
553 #ifdef HAVE_ST_BLKSIZE
554 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
555 dbcachesize /= st.st_blksize;
556 if( dbcachesize == 0 ) dbcachesize = 1;
557 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
560 if ( dbcachesize > 0 ) {
562 if( dbcachesize == 0 ) dbcachesize = 1;
563 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
573 ldbm_close( LDBM ldbm )
581 ldbm_sync( LDBM ldbm )
589 ldbm_fetch( LDBM ldbm, Datum key )
594 d = gdbm_fetch( ldbm, key );
601 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
606 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
607 if ( flags & LDBM_SYNC )
615 ldbm_delete( LDBM ldbm, Datum key )
620 rc = gdbm_delete( ldbm, key );
628 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
633 d = gdbm_firstkey( ldbm );
636 if ( d.dptr != NULL ) {
637 *dbcp = (Datum *) malloc( sizeof( Datum ) );
638 **dbcp = ldbm_datum_dup( ldbm, d );
645 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
650 d = gdbm_nextkey( ldbm, *dbcp );
653 ldbm_datum_free( ldbm, *dbcp );
655 if ( d.dptr != NULL ) {
656 *dbcp = ldbm_datum_dup( ldbm, d );
665 ldbm_errno( LDBM ldbm )
678 /* MMAPED DBM HASHING DATABASE */
680 #include <ac/string.h>
682 /* #define MDBM_DEBUG */
689 /* #define MDBM_CHAIN */
696 #define mdbm_store mdbm_chain_store
697 #define mdbm_fetch mdbm_chain_fetch
698 #define mdbm_delete mdbm_chain_delete
699 #define mdbm_first mdbm_chain_first
700 #define mdbm_next mdbm_chain_next
704 #define MDBM_PG_SZ (4*1024)
706 /*****************************************************************
710 *****************************************************************/
713 ldbm_open( char *name, int rw, int mode, int dbcachesize )
719 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
720 name ? name : "NULL", rw, mode, dbcachesize );
724 LDBM_LOCK; /* We need locking here, this is the only non-thread
725 * safe function we have.
728 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
732 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
740 (void)mdbm_set_chain(db);
746 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
758 ldbm_close( LDBM ldbm )
761 /* Open and close are not reentrant so we need to use locks here */
765 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
774 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
784 ldbm_sync( LDBM ldbm )
787 /* XXX: Not sure if this is re-entrant need to check code, if so
788 * you can leave LOCKS out.
798 #define MAX_MDBM_RETRY 5
801 ldbm_fetch( LDBM ldbm, Datum key )
807 /* This hack is needed because MDBM does not take keys
808 * which begin with NULL when working in the chaining
815 k.key.dsize = key.dsize + 1;
816 k.key.dptr = malloc(k.key.dsize);
818 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
828 d = mdbm_fetch( ldbm, k );
832 if ( k.val.dptr != NULL ) {
838 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
840 k.val.dsize = d.dsize;
841 d = mdbm_fetch( ldbm, k );
850 }/* if ( d.dsize > 0 ) */
852 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
868 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
871 Datum int_key; /* Internal key */
875 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
876 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
883 int_key.dsize = key.dsize + 1;
884 int_key.dptr = malloc( int_key.dsize );
885 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
886 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
891 rc = mdbm_store( ldbm, int_key, data, flags );
892 if ( flags & LDBM_SYNC ) {
899 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
914 ldbm_delete( LDBM ldbm, Datum key )
922 int_key.dsize = key.dsize + 1;
923 int_key.dptr = malloc(int_key.dsize);
924 *(int_key.dptr) = 'l';
925 AC_MEMCPY( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
930 rc = mdbm_delete( ldbm, int_key );
945 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
951 size_t sz = MDBM_PAGE_SIZE(ldbm);
960 in.key.dsize = sz; /* Assume first key in one pg */
961 in.key.dptr = malloc(sz);
963 in.val.dptr = NULL; /* Don't need data just key */
969 out = fptr( ldbm, in );
971 if (out.key.dsize > 0) {
973 ret.dsize = out.key.dsize - delta;
974 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
981 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
1000 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1003 return ldbm_get_next( ldbm, mdbm_first );
1011 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1015 * don't know if this will affect the LDAP server opertaion
1016 * but mdbm cannot take and input key.
1019 return ldbm_get_next( ldbm, mdbm_next );
1024 ldbm_errno( LDBM ldbm )
1026 /* XXX: best we can do with current mdbm interface */
1034 #elif defined( HAVE_NDBM )
1036 /*****************************************************************
1038 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1040 *****************************************************************/
1044 ldbm_open( char *name, int rw, int mode, int dbcachesize )
1049 ldbm = dbm_open( name, rw, mode );
1056 ldbm_close( LDBM ldbm )
1065 ldbm_sync( LDBM ldbm )
1071 ldbm_fetch( LDBM ldbm, Datum key )
1076 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1083 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1088 rc = dbm_store( ldbm, key, data, flags );
1095 ldbm_delete( LDBM ldbm, Datum key )
1100 rc = dbm_delete( ldbm, key );
1107 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1112 d = dbm_firstkey( ldbm );
1119 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1124 d = dbm_nextkey( ldbm );
1131 ldbm_errno( LDBM ldbm )
1136 err = dbm_error( ldbm );