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_DB_THREAD
63 /* Only DB2 with DB_THREAD is thread-free */
64 static ldap_pvt_thread_mutex_t ldbm_big_mutex;
65 #define LDBM_LOCK (ldap_pvt_thread_mutex_lock(&ldbm_big_mutex))
66 #define LDBM_UNLOCK (ldap_pvt_thread_mutex_unlock(&ldbm_big_mutex))
69 #define LDBM_LOCK ((void)0)
70 #define LDBM_UNLOCK ((void)0)
73 #ifndef HAVE_BERKELEY_DB2
75 int ldbm_initialize( void )
77 if(ldbm_initialized++) return 1;
79 ldap_pvt_thread_mutex_init( &ldbm_big_mutex );
84 int ldbm_shutdown( void )
86 if( !ldbm_initialized ) return 1;
88 ldap_pvt_thread_mutex_destroy( &ldbm_big_mutex );
96 ldbm_malloc( size_t size )
98 return( calloc( 1, size ));
102 #include <ac/syslog.h>
106 ldbm_db_errcall( const char *prefix, char *message )
109 syslog( LOG_INFO, "ldbm_db_errcall(): %s %s", prefix, message );
113 /* a dbEnv for BERKELEYv2 */
114 static DB_ENV ldbm_Env_internal;
115 DB_ENV *ldbm_Env = NULL;
117 int ldbm_initialize( void )
122 if(ldbm_initialized++) return 1;
124 memset( &ldbm_Env_internal, 0, sizeof( DB_ENV ));
125 ldbm_Env = &ldbm_Env_internal;
127 ldbm_Env->db_errcall = ldbm_db_errcall;
128 ldbm_Env->db_errpfx = "==>";
131 #ifdef HAVE_BERKELEY_DB2_DB_THREAD
136 if ( ( err = db_appinit( NULL, NULL, ldbm_Env, envFlags )) ) {
140 sprintf( error, "%ld\n", (long) err );
142 sprintf( error, "%s\n", strerror( err ));
147 "ldbm_initialize(): FATAL error in db_appinit() : %s\n",
156 int ldbm_shutdown( void )
158 if( !ldbm_initialized ) return 1;
160 db_appexit( ldbm_Env );
167 #if defined( LDBM_USE_DBHASH ) || defined( LDBM_USE_DBBTREE )
169 /*****************************************************************
171 * use berkeley db hash or btree package *
173 *****************************************************************/
176 ldbm_open( char *name, int rw, int mode, int dbcachesize )
180 #ifdef HAVE_BERKELEY_DB2
183 memset( &dbinfo, 0, sizeof( dbinfo ));
185 #if defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
186 DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR == 4
188 * BerkeleyDB 2.4 do not allow db_cachesize
189 * to be specified if an DB_ENV is.
192 /* set db_cachesize of MPOOL is NOT being used. */
193 if (( ldbm_Env == NULL ) || ( ldbm_Env->mp_info == NULL ))
194 dbinfo.db_cachesize = dbcachesize;
197 dbinfo.db_pagesize = DEFAULT_DB_PAGE_SIZE;
198 dbinfo.db_malloc = ldbm_malloc;
201 (void) db_open( name, DB_TYPE, rw, mode, ldbm_Env, &dbinfo, &ret );
209 if ( DB_TYPE == DB_HASH ) {
210 memset( (char *) &hinfo, '\0', sizeof(hinfo) );
211 hinfo.cachesize = dbcachesize;
213 } else if ( DB_TYPE == DB_BTREE ) {
214 memset( (char *) &binfo, '\0', sizeof(binfo) );
215 binfo.cachesize = dbcachesize;
222 ret = dbopen( name, rw, mode, DB_TYPE, info );
231 ldbm_close( LDBM ldbm )
234 #ifdef HAVE_BERKELEY_DB2
235 (*ldbm->close)( ldbm, 0 );
237 (*ldbm->close)( ldbm );
243 ldbm_sync( LDBM ldbm )
246 (*ldbm->sync)( ldbm, 0 );
251 ldbm_fetch( LDBM ldbm, Datum key )
258 #ifdef HAVE_BERKELEY_DB2
259 ldbm_datum_init( data );
261 data.flags = DB_DBT_MALLOC;
263 if ( (rc = (*ldbm->get)( ldbm, NULL, &key, &data, 0 )) != 0 ) {
264 ldbm_datum_free( ldbm, data );
266 if ( (rc = (*ldbm->get)( ldbm, &key, &data, 0 )) == 0 ) {
267 /* Berkeley DB 1.85 don't malloc the data for us */
268 /* duplicate it for to ensure reentrancy */
269 data = ldbm_datum_dup( ldbm, data );
282 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
288 #ifdef HAVE_BERKELEY_DB2
289 rc = (*ldbm->put)( ldbm, NULL, &key, &data, flags & ~LDBM_SYNC );
292 rc = (*ldbm->put)( ldbm, &key, &data, flags & ~LDBM_SYNC );
295 if ( flags & LDBM_SYNC )
296 (*ldbm->sync)( ldbm, 0 );
304 ldbm_delete( LDBM ldbm, Datum key )
310 #ifdef HAVE_BERKELEY_DB2
311 rc = (*ldbm->del)( ldbm, NULL, &key, 0 );
314 rc = (*ldbm->del)( ldbm, &key, 0 );
316 (*ldbm->sync)( ldbm, 0 );
324 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbch )
328 #ifdef HAVE_BERKELEY_DB2
331 ldbm_datum_init( key );
332 ldbm_datum_init( data );
334 key.flags = data.flags = DB_DBT_MALLOC;
338 /* acquire a cursor for the DB */
340 # if defined( DB_VERSION_MAJOR ) && defined( DB_VERSION_MINOR ) && \
341 DB_VERSION_MAJOR == 2 && DB_VERSION_MINOR < 6
343 if ( (*ldbm->cursor)( ldbm, NULL, &dbci ))
346 if ( (*ldbm->cursor)( ldbm, NULL, &dbci, 0 ))
353 if ( (*dbci->c_get)( dbci, &key, &data, DB_NEXT ) == 0 ) {
354 ldbm_datum_free( ldbm, data );
362 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_FIRST )) == 0 ) {
363 key = ldbm_datum_dup( ldbm, key );
371 #ifdef HAVE_BERKELEY_DB2
381 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
385 #ifdef HAVE_BERKELEY_DB2
386 ldbm_datum_init( data );
388 ldbm_datum_free( ldbm, key );
389 key.flags = data.flags = DB_DBT_MALLOC;
393 if ( (*dbcp->c_get)( dbcp, &key, &data, DB_NEXT ) == 0 ) {
394 ldbm_datum_free( ldbm, data );
402 if ( (rc = (*ldbm->seq)( ldbm, &key, &data, R_NEXT )) == 0 ) {
403 key = ldbm_datum_dup( ldbm, key );
417 ldbm_errno( LDBM ldbm )
422 #elif defined( HAVE_GDBM )
424 #ifdef HAVE_ST_BLKSIZE
425 #include <sys/stat.h>
428 /*****************************************************************
432 *****************************************************************/
435 ldbm_open( char *name, int rw, int mode, int dbcachesize )
438 #ifdef HAVE_ST_BLKSIZE
444 if ( (db = gdbm_open( name, 0, rw | GDBM_FAST, mode, 0 )) == NULL ) {
449 #ifdef HAVE_ST_BLKSIZE
450 if ( dbcachesize > 0 && stat( name, &st ) == 0 ) {
451 dbcachesize /= st.st_blksize;
452 if( dbcachesize == 0 ) dbcachesize = 1;
453 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
456 if ( dbcachesize > 0 ) {
458 if( dbcachesize == 0 ) dbcachesize = 1;
459 gdbm_setopt( db, GDBM_CACHESIZE, &dbcachesize, sizeof(int) );
469 ldbm_close( LDBM ldbm )
477 ldbm_sync( LDBM ldbm )
485 ldbm_fetch( LDBM ldbm, Datum key )
490 d = gdbm_fetch( ldbm, key );
497 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
502 rc = gdbm_store( ldbm, key, data, flags & ~LDBM_SYNC );
503 if ( flags & LDBM_SYNC )
511 ldbm_delete( LDBM ldbm, Datum key )
516 rc = gdbm_delete( ldbm, key );
524 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
529 d = gdbm_firstkey( ldbm );
532 if ( d.dptr != NULL ) {
533 *dbcp = (Datum *) malloc( sizeof( Datum ) );
534 **dbcp = ldbm_datum_dup( ldbm, d );
541 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
546 d = gdbm_nextkey( ldbm, *dbcp );
549 ldbm_datum_free( ldbm, *dbcp );
551 if ( d.dptr != NULL ) {
552 *dbcp = ldbm_datum_dup( ldbm, d );
561 ldbm_errno( LDBM ldbm )
574 /* MMAPED DBM HASHING DATABASE */
576 #include <ac/string.h>
578 /* #define MDBM_DEBUG */
585 /* #define MDBM_CHAIN */
592 #define mdbm_store mdbm_chain_store
593 #define mdbm_fetch mdbm_chain_fetch
594 #define mdbm_delete mdbm_chain_delete
595 #define mdbm_first mdbm_chain_first
596 #define mdbm_next mdbm_chain_next
600 #define MDBM_PG_SZ (4*1024)
602 /*****************************************************************
606 *****************************************************************/
609 ldbm_open( char *name, int rw, int mode, int dbcachesize )
615 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
616 name ? name : "NULL", rw, mode, dbcachesize );
620 LDBM_LOCK; /* We need locking here, this is the only non-thread
621 * safe function we have.
624 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
628 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
636 (void)mdbm_set_chain(db);
642 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
654 ldbm_close( LDBM ldbm )
657 /* Open and close are not reentrant so we need to use locks here */
661 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
670 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
680 ldbm_sync( LDBM ldbm )
683 /* XXX: Not sure if this is re-entrant need to check code, if so
684 * you can leave LOCKS out.
694 #define MAX_MDBM_RETRY 5
697 ldbm_fetch( LDBM ldbm, Datum key )
703 /* This hack is needed because MDBM does not take keys
704 * which begin with NULL when working in the chaining
711 k.key.dsize = key.dsize + 1;
712 k.key.dptr = malloc(k.key.dsize);
714 memcpy( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
724 d = mdbm_fetch( ldbm, k );
728 if ( k.val.dptr != NULL ) {
734 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
736 k.val.dsize = d.dsize;
737 d = mdbm_fetch( ldbm, k );
746 }/* if ( d.dsize > 0 ) */
748 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
764 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
767 Datum int_key; /* Internal key */
771 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
772 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
779 int_key.dsize = key.dsize + 1;
780 int_key.dptr = malloc( int_key.dsize );
781 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
782 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
787 rc = mdbm_store( ldbm, int_key, data, flags );
788 if ( flags & LDBM_SYNC ) {
795 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
810 ldbm_delete( LDBM ldbm, Datum key )
818 int_key.dsize = key.dsize + 1;
819 int_key.dptr = malloc(int_key.dsize);
820 *(int_key.dptr) = 'l';
821 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
826 rc = mdbm_delete( ldbm, int_key );
841 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
847 size_t sz = MDBM_PAGE_SIZE(ldbm);
856 in.key.dsize = sz; /* Assume first key in one pg */
857 in.key.dptr = malloc(sz);
859 in.val.dptr = NULL; /* Don't need data just key */
865 out = fptr( ldbm, in );
867 if (out.key.dsize > 0) {
869 ret.dsize = out.key.dsize - delta;
870 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
877 memcpy(ret.dptr, (void *)(out.key.dptr + delta),
896 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
899 return ldbm_get_next( ldbm, mdbm_first );
907 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
911 * don't know if this will affect the LDAP server opertaion
912 * but mdbm cannot take and input key.
915 return ldbm_get_next( ldbm, mdbm_next );
920 ldbm_errno( LDBM ldbm )
922 /* XXX: best we can do with current mdbm interface */
930 #elif defined( HAVE_NDBM )
932 /*****************************************************************
934 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
936 *****************************************************************/
940 ldbm_open( char *name, int rw, int mode, int dbcachesize )
945 ldbm = dbm_open( name, rw, mode );
952 ldbm_close( LDBM ldbm )
961 ldbm_sync( LDBM ldbm )
967 ldbm_fetch( LDBM ldbm, Datum key )
972 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
979 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
984 rc = dbm_store( ldbm, key, data, flags );
991 ldbm_delete( LDBM ldbm, Datum key )
996 rc = dbm_delete( ldbm, key );
1003 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
1008 d = dbm_firstkey( ldbm );
1015 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1020 d = dbm_nextkey( ldbm );
1027 ldbm_errno( LDBM ldbm )
1032 err = dbm_error( ldbm );