1 /* ldbm.c - ldap dbm compatibility routines */
4 * Copyright 1998-1999 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"
30 ldbm_datum_free( LDBM ldbm, Datum data )
34 memset( &data, 0, sizeof( Datum ));
41 ldbm_datum_dup( LDBM ldbm, Datum data )
45 ldbm_datum_init( dup );
47 if ( data.dsize == 0 ) {
53 dup.dsize = data.dsize;
54 if ( (dup.dptr = (char *) malloc( data.dsize )) != NULL )
55 memcpy( dup.dptr, data.dptr, data.dsize );
60 static int ldbm_initialized = 0;
62 #ifndef HAVE_BERKELEY_DB2
63 /* Everything but DB2 is non-reentrant */
65 static ldap_pvt_thread_mutex_t ldbm_big_mutex;
66 #define LDBM_LOCK (ldap_pvt_thread_mutex_lock(&ldbm_big_mutex))
67 #define LDBM_UNLOCK (ldap_pvt_thread_mutex_unlock(&ldbm_big_mutex))
69 int ldbm_initialize( void )
71 if(ldbm_initialized++) return 1;
73 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
78 int ldbm_shutdown( void )
80 if( !ldbm_initialized ) return 1;
82 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
90 ldbm_malloc( size_t size )
92 return( calloc( 1, size ));
96 #include <ac/syslog.h>
100 ldbm_db_errcall( const char *prefix, char *message )
103 syslog( LOG_INFO, "ldbm_db_errcall(): %s %s", prefix, message );
107 /* a dbEnv for BERKELEYv2 */
108 static DB_ENV ldbm_Env_internal;
109 DB_ENV *ldbm_Env = NULL;
111 /* Berkeley DB 2.x is reentrant */
112 #define LDBM_LOCK ((void)0)
113 #define LDBM_UNLOCK ((void)0)
115 int ldbm_initialize( void )
120 if(ldbm_initialized++) return 1;
122 memset( &ldbm_Env_internal, 0, sizeof( DB_ENV ));
123 ldbm_Env = &ldbm_Env_internal;
125 ldbm_Env->db_errcall = ldbm_db_errcall;
126 ldbm_Env->db_errpfx = "==>";
128 envFlags = DB_CREATE | DB_THREAD;
130 if ( ( err = db_appinit( NULL, NULL, ldbm_Env, envFlags )) ) {
134 sprintf( error, "%ld\n", (long) err );
136 sprintf( error, "%s\n", strerror( err ));
141 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
150 int ldbm_shutdown( void )
152 if( !ldbm_initialized ) return 1;
154 db_appexit( ldbm_Env );
161 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
163 /*****************************************************************
165 * use berkeley db hash or btree package *
167 *****************************************************************/
170 ldbm_open( char *name, int rw, int mode, int dbcachesize )
174 #ifdef HAVE_BERKELEY_DB2
177 memset( &dbinfo, 0, sizeof( dbinfo ));
179 #if defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
180 DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
182 * BerkeleyDB 2.4 do not allow db_cachesize
183 * to be specified if an DB_ENV is.
186 /* set db_cachesize of MPOOL is NOT being used. */
187 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL ))
188 dbinfo.db_cachesize = dbcachesize;
191 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
192 dbinfo.db_malloc = ldbm_malloc;
195 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
203 if ( DB_TYPE == DB_HASH ) {
204 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
205 hinfo.cachesize = dbcachesize;
207 } else if ( DB_TYPE == DB_BTREE ) {
208 memset( (char *) &binfo, '\0', sizeof(binfo) );
209 binfo.cachesize = dbcachesize;
216 ret = dbopen( name, rw, mode, DB_TYPE, info );
225 ldbm_close( LDBM ldbm )
228 #ifdef HAVE_BERKELEY_DB2
229 (*ldbm->close)( ldbm, 0 );
231 (*ldbm->close)( ldbm );
237 ldbm_sync( LDBM ldbm )
240 (*ldbm->sync)( ldbm, 0 );
245 ldbm_fetch( LDBM ldbm, Datum key )
252 #ifdef HAVE_BERKELEY_DB2
253 ldbm_datum_init( data );
255 data.flags = DB_DBT_MALLOC;
257 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
258 ldbm_datum_free( ldbm, data );
260 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
261 /* Berkeley DB 1.85 don't malloc the data for us */
262 /* duplicate it for to ensure reentrancy */
263 data = ldbm_datum_dup( ldbm, data );
276 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
282 #ifdef HAVE_BERKELEY_DB2
283 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
286 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
289 if ( flags & LDBM_SYNC )
290 (*ldbm->sync)( ldbm, 0 );
298 ldbm_delete( LDBM ldbm, Datum key )
304 #ifdef HAVE_BERKELEY_DB2
305 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
308 rc = (*ldbm->del)( ldbm, &key, 0 );
310 (*ldbm->sync)( ldbm, 0 );
318 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
322 #ifdef HAVE_BERKELEY_DB2
325 ldbm_datum_init( key );
326 ldbm_datum_init( data );
328 key.flags = data.flags = DB_DBT_MALLOC;
332 /* acquire a cursor for the DB */
334 # if defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
335 DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6
337 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
340 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
347 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
348 ldbm_datum_free( ldbm, data );
356 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
357 key = ldbm_datum_dup( ldbm, key );
365 #ifdef HAVE_BERKELEY_DB2
375 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
379 #ifdef HAVE_BERKELEY_DB2
380 ldbm_datum_init( data );
382 ldbm_datum_free( ldbm, key );
383 key.flags = data.flags = DB_DBT_MALLOC;
387 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
388 ldbm_datum_free( ldbm, data );
396 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
397 key = ldbm_datum_dup( ldbm, key );
411 ldbm_errno( LDBM ldbm )
416 #elif defined( HAVE_GDBM )
418 #ifdef HAVE_ST_BLKSIZE
419 #include <sys/stat.h>
422 /*****************************************************************
426 *****************************************************************/
429 ldbm_open( char *name, int rw, int mode, int dbcachesize )
432 #ifdef HAVE_ST_BLKSIZE
438 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
443 #ifdef HAVE_ST_BLKSIZE
444 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
445 dbcachesize /= st.st_blksize;
446 if( dbcachesize == 0 ) dbcachesize = 1;
447 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
450 if ( dbcachesize > 0 ) {
452 if( dbcachesize == 0 ) dbcachesize = 1;
453 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
463 ldbm_close( LDBM ldbm )
471 ldbm_sync( LDBM ldbm )
479 ldbm_fetch( LDBM ldbm, Datum key )
484 d = gdbm_fetch( ldbm, key );
491 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
496 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
497 if ( flags & LDBM_SYNC )
505 ldbm_delete( LDBM ldbm, Datum key )
510 rc = gdbm_delete( ldbm, key );
518 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
523 d = gdbm_firstkey( ldbm );
530 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
535 d = gdbm_nextkey( ldbm, key );
542 ldbm_errno( LDBM ldbm )
555 /* MMAPED DBM HASHING DATABASE */
557 #include <ac/string.h>
559 /* #define MDBM_DEBUG */
566 /* #define MDBM_CHAIN */
573 #define mdbm_store mdbm_chain_store
574 #define mdbm_fetch mdbm_chain_fetch
575 #define mdbm_delete mdbm_chain_delete
576 #define mdbm_first mdbm_chain_first
577 #define mdbm_next mdbm_chain_next
581 #define MDBM_PG_SZ (4*1024)
583 /*****************************************************************
587 *****************************************************************/
590 ldbm_open( char *name, int rw, int mode, int dbcachesize )
596 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
597 name ? name : "NULL", rw, mode, dbcachesize );
601 LDBM_LOCK; /* We need locking here, this is the only non-thread
602 * safe function we have.
605 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
609 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
617 (void)mdbm_set_chain(db);
623 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
635 ldbm_close( LDBM ldbm )
638 /* Open and close are not reentrant so we need to use locks here */
642 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
651 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
661 ldbm_sync( LDBM ldbm )
664 /* XXX: Not sure if this is re-entrant need to check code, if so
665 * you can leave LOCKS out.
675 #define MAX_MDBM_RETRY 5
678 ldbm_fetch( LDBM ldbm, Datum key )
684 /* This hack is needed because MDBM does not take keys
685 * which begin with NULL when working in the chaining
692 k.key.dsize = key.dsize + 1;
693 k.key.dptr = malloc(k.key.dsize);
695 memcpy( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
705 d = mdbm_fetch( ldbm, k );
709 if ( k.val.dptr != NULL ) {
715 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
717 k.val.dsize = d.dsize;
718 d = mdbm_fetch( ldbm, k );
727 }/* if ( d.dsize > 0 ) */
729 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
745 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
748 Datum int_key; /* Internal key */
752 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
753 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
760 int_key.dsize = key.dsize + 1;
761 int_key.dptr = malloc( int_key.dsize );
762 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
763 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
768 rc = mdbm_store( ldbm, int_key, data, flags );
769 if ( flags & LDBM_SYNC ) {
776 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
791 ldbm_delete( LDBM ldbm, Datum key )
799 int_key.dsize = key.dsize + 1;
800 int_key.dptr = malloc(int_key.dsize);
801 *(int_key.dptr) = 'l';
802 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
807 rc = mdbm_delete( ldbm, int_key );
822 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
828 size_t sz = MDBM_PAGE_SIZE(ldbm);
837 in.key.dsize = sz; /* Assume first key in one pg */
838 in.key.dptr = malloc(sz);
840 in.val.dptr = NULL; /* Don't need data just key */
846 out = fptr( ldbm, in );
848 if (out.key.dsize > 0) {
850 ret.dsize = out.key.dsize - delta;
851 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
858 memcpy(ret.dptr, (void *)(out.key.dptr + delta),
877 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
880 return ldbm_get_next( ldbm, mdbm_first );
888 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
892 * don't know if this will affect the LDAP server opertaion
893 * but mdbm cannot take and input key.
896 return ldbm_get_next( ldbm, mdbm_next );
901 ldbm_errno( LDBM ldbm )
903 /* XXX: best we can do with current mdbm interface */
911 #elif defined( HAVE_NDBM )
913 /*****************************************************************
915 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
917 *****************************************************************/
921 ldbm_open( char *name, int rw, int mode, int dbcachesize )
926 ldbm = dbm_open( name, rw, mode );
933 ldbm_close( LDBM ldbm )
942 ldbm_sync( LDBM ldbm )
948 ldbm_fetch( LDBM ldbm, Datum key )
953 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
960 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
965 rc = dbm_store( ldbm, key, data, flags );
972 ldbm_delete( LDBM ldbm, Datum key )
977 rc = dbm_delete( ldbm, key );
984 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
989 d = dbm_firstkey( ldbm );
996 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1001 d = dbm_nextkey( ldbm );
1008 ldbm_errno( LDBM ldbm )
1013 err = dbm_error( ldbm );