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;
109 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
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 = "==>";
122 envFlags = DB_CREATE;
124 /* add optional flags */
126 envFlags |= DB_PRIVATE;
128 #ifdef HAVE_BERKELEY_DB_THREAD
129 envFlags |= DB_THREAD;
130 #if DB_VERSION_MAJOR == 2
131 envFlags |= DB_INIT_CDB | DB_INIT_MPOOL;
135 #if DB_VERSION_MAJOR >= 3
136 err = db_env_create( &ldbm_Env, 0 );
138 envFlags |= DB_USE_ENVIRON;
139 err = db_appinit( home, NULL, ldbm_Env, envFlags );
146 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
149 #if DB_VERSION_MAJOR >= 3
150 "ldbm_initialize(): FATAL error in db_env_create() : %s\n",
152 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
159 #if DB_VERSION_MAJOR > 2
160 ldbm_Env->set_errcall( ldbm_Env, ldbm_db_errcall );
161 ldbm_Env->set_errpfx( ldbm_Env, "==>" );
163 #ifdef HAVE_BERKELEY_DB_THREAD
164 envFlags |= DB_INIT_CDB | DB_INIT_MPOOL;
166 envFlags |= DB_USE_ENVIRON;
168 #if (DB_VERSION_MAJOR > 3) || (DB_VERSION_MINOR >= 1)
169 err = ldbm_Env->open( ldbm_Env, home, envFlags, 0 );
171 err = ldbm_Env->open( ldbm_Env, home, NULL, envFlags, 0 );
178 sprintf( error, "%s (%d)\n", STRERROR( err ), err );
180 "ldbm_initialize(): FATAL error in dbEnv->open() : %s\n",
183 ldbm_Env->close( ldbm_Env, 0 );
191 int ldbm_shutdown( void )
193 if( !ldbm_initialized ) return 1;
195 #if DB_VERSION_MAJOR >= 3
196 ldbm_Env->close( ldbm_Env, 0 );
198 db_appexit( ldbm_Env );
201 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
206 #else /* some DB other than Berkeley V2 or greater */
208 int ldbm_initialize( const char * home )
210 if(ldbm_initialized++) return 1;
212 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
217 int ldbm_shutdown( void )
219 if( !ldbm_initialized ) return 1;
221 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
226 #endif /* HAVE_BERKELEY_DB */
229 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
231 /*****************************************************************
233 * use berkeley db hash or btree package *
235 *****************************************************************/
238 ldbm_open( char *name, int rw, int mode, int dbcachesize )
242 #if DB_VERSION_MAJOR >= 3
247 err = db_create( &ret, ldbm_Env, 0 );
249 (void)ret->close(ret, 0);
253 ret->set_pagesize( ret, DEFAULT_DB_PAGE_SIZE );
254 ret->set_malloc( ret, ldbm_malloc );
256 err = ret->open( ret, name, NULL, DB_TYPE, rw, mode);
261 (void)ret->close(ret, 0);
265 #elif DB_VERSION_MAJOR >= 2
268 memset( &dbinfo, '\0', sizeof( dbinfo ));
270 #if DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
272 * BerkeleyDB 2.4 do not allow db_cachesize
273 * to be specified if an DB_ENV is.
276 /* set db_cachesize of MPOOL is NOT being used. */
277 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL )) {
278 dbinfo.db_cachesize = dbcachesize;
282 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
283 dbinfo.db_malloc = ldbm_malloc;
286 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
294 if ( DB_TYPE == DB_HASH ) {
295 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
296 hinfo.cachesize = dbcachesize;
298 } else if ( DB_TYPE == DB_BTREE ) {
299 memset( (char *) &binfo, '\0', sizeof(binfo) );
300 binfo.cachesize = dbcachesize;
307 ret = dbopen( name, rw, mode, DB_TYPE, info );
315 ldbm_close( LDBM ldbm )
318 #if DB_VERSION_MAJOR >= 3
319 ldbm->close( ldbm, 0 );
320 #elif DB_VERSION_MAJOR >= 2
321 (*ldbm->close)( ldbm, 0 );
323 (*ldbm->close)( ldbm );
329 ldbm_sync( LDBM ldbm )
332 (*ldbm->sync)( ldbm, 0 );
337 ldbm_fetch( LDBM ldbm, Datum key )
344 #if DB_VERSION_MAJOR >= 3
345 ldbm_datum_init( data );
347 data.flags = DB_DBT_MALLOC;
349 if ( (rc = ldbm->get( ldbm, NULL, &key, &data, 0 )) != 0 ) {
350 ldbm_datum_free( ldbm, data );
355 #elif DB_VERSION_MAJOR >= 2
356 ldbm_datum_init( data );
358 data.flags = DB_DBT_MALLOC;
360 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
361 ldbm_datum_free( ldbm, data );
367 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
368 /* Berkeley DB 1.85 don't malloc the data for us */
369 /* duplicate it for to ensure reentrancy */
370 data = ldbm_datum_dup( ldbm, data );
383 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
389 #if DB_VERSION_MAJOR >= 3
390 rc = ldbm->put( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
393 #elif DB_VERSION_MAJOR >= 2
394 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
397 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
400 if ( flags & LDBM_SYNC )
401 (*ldbm->sync)( ldbm, 0 );
409 ldbm_delete( LDBM ldbm, Datum key )
415 #if DB_VERSION_MAJOR >= 3
416 rc = ldbm->del( ldbm, NULL, &key, 0 );
418 #elif DB_VERSION_MAJOR >= 2
419 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
422 rc = (*ldbm->del)( ldbm, &key, 0 );
424 (*ldbm->sync)( ldbm, 0 );
432 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
436 #if DB_VERSION_MAJOR >= 2
439 ldbm_datum_init( key );
440 ldbm_datum_init( data );
442 key.flags = data.flags = DB_DBT_MALLOC;
446 /* acquire a cursor for the DB */
447 # if DB_VERSION_MAJOR >= 3
448 if ( ldbm->cursor( ldbm, NULL, &dbci, 0 ) )
449 # elif defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
450 (DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6)
452 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
455 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
462 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
463 ldbm_datum_free( ldbm, data );
471 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
472 key = ldbm_datum_dup( ldbm, key );
480 #if DB_VERSION_MAJOR >= 2
490 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
494 #if DB_VERSION_MAJOR >= 2
495 ldbm_datum_init( data );
497 ldbm_datum_free( ldbm, key );
498 key.flags = data.flags = DB_DBT_MALLOC;
502 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
503 ldbm_datum_free( ldbm, data );
511 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
512 key = ldbm_datum_dup( ldbm, key );
526 ldbm_errno( LDBM ldbm )
531 /******************************************************************
533 * END Berkeley section *
535 ******************************************************************/
537 #elif defined( HAVE_GDBM )
539 #ifdef HAVE_ST_BLKSIZE
540 #include <sys/stat.h>
543 /*****************************************************************
547 *****************************************************************/
550 ldbm_open( char *name, int rw, int mode, int dbcachesize )
553 #ifdef HAVE_ST_BLKSIZE
559 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
564 #ifdef HAVE_ST_BLKSIZE
565 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
566 dbcachesize /= st.st_blksize;
567 if( dbcachesize == 0 ) dbcachesize = 1;
568 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
571 if ( dbcachesize > 0 ) {
573 if( dbcachesize == 0 ) dbcachesize = 1;
574 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
584 ldbm_close( LDBM ldbm )
592 ldbm_sync( LDBM ldbm )
600 ldbm_fetch( LDBM ldbm, Datum key )
605 d = gdbm_fetch( ldbm, key );
612 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
617 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
618 if ( flags & LDBM_SYNC )
626 ldbm_delete( LDBM ldbm, Datum key )
631 rc = gdbm_delete( ldbm, key );
639 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
644 d = gdbm_firstkey( ldbm );
647 if ( d.dptr != NULL ) {
648 *dbcp = (Datum *) malloc( sizeof( Datum ) );
649 **dbcp = ldbm_datum_dup( ldbm, d );
656 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
661 d = gdbm_nextkey( ldbm, *dbcp );
664 ldbm_datum_free( ldbm, *dbcp );
666 if ( d.dptr != NULL ) {
667 *dbcp = ldbm_datum_dup( ldbm, d );
676 ldbm_errno( LDBM ldbm )
689 /* MMAPED DBM HASHING DATABASE */
691 #include <ac/string.h>
693 /* #define MDBM_DEBUG */
700 /* #define MDBM_CHAIN */
707 #define mdbm_store mdbm_chain_store
708 #define mdbm_fetch mdbm_chain_fetch
709 #define mdbm_delete mdbm_chain_delete
710 #define mdbm_first mdbm_chain_first
711 #define mdbm_next mdbm_chain_next
715 #define MDBM_PG_SZ (4*1024)
717 /*****************************************************************
721 *****************************************************************/
724 ldbm_open( char *name, int rw, int mode, int dbcachesize )
730 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
731 name ? name : "NULL", rw, mode, dbcachesize );
735 LDBM_LOCK; /* We need locking here, this is the only non-thread
736 * safe function we have.
739 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
743 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
751 (void)mdbm_set_chain(db);
757 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
769 ldbm_close( LDBM ldbm )
772 /* Open and close are not reentrant so we need to use locks here */
776 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
785 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
795 ldbm_sync( LDBM ldbm )
797 /* XXX: Not sure if this is re-entrant need to check code, if so
798 * you can leave LOCKS out.
807 #define MAX_MDBM_RETRY 5
810 ldbm_fetch( LDBM ldbm, Datum key )
816 /* This hack is needed because MDBM does not take keys
817 * which begin with NULL when working in the chaining
824 k.key.dsize = key.dsize + 1;
825 k.key.dptr = malloc(k.key.dsize);
827 AC_MEMCPY( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
837 d = mdbm_fetch( ldbm, k );
841 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 );
951 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
956 size_t sz = MDBM_PAGE_SIZE(ldbm);
965 in.key.dsize = sz; /* Assume first key in one pg */
966 in.key.dptr = malloc(sz);
968 in.val.dptr = NULL; /* Don't need data just key */
974 out = fptr( ldbm, in );
976 if (out.key.dsize > 0) {
977 ret.dsize = out.key.dsize - delta;
979 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
984 AC_MEMCPY(ret.dptr, (void *)(out.key.dptr + delta),
996 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
998 return ldbm_get_next( ldbm, mdbm_first );
1002 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1005 * don't know if this will affect the LDAP server operation
1006 * but mdbm cannot take and input key.
1009 return ldbm_get_next( ldbm, mdbm_next );
1013 ldbm_errno( LDBM ldbm )
1015 /* XXX: best we can do with current mdbm interface */
1022 #elif defined( HAVE_NDBM )
1024 /*****************************************************************
1026 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
1028 *****************************************************************/
1032 ldbm_open( char *name, int rw, int mode, int dbcachesize )
1037 ldbm = dbm_open( name, rw, mode );
1044 ldbm_close( LDBM ldbm )
1053 ldbm_sync( LDBM ldbm )
1059 ldbm_fetch( LDBM ldbm, Datum key )
1064 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
1071 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
1076 rc = dbm_store( ldbm, key, data, flags );
1083 ldbm_delete( LDBM ldbm, Datum key )
1088 rc = dbm_delete( ldbm, key );
1095 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1100 d = dbm_firstkey( ldbm );
1107 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1112 d = dbm_nextkey( ldbm );
1119 ldbm_errno( LDBM ldbm )
1124 err = dbm_error( ldbm );