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 );
536 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
541 d = gdbm_nextkey( ldbm, key );
548 ldbm_errno( LDBM ldbm )
561 /* MMAPED DBM HASHING DATABASE */
563 #include <ac/string.h>
565 /* #define MDBM_DEBUG */
572 /* #define MDBM_CHAIN */
579 #define mdbm_store mdbm_chain_store
580 #define mdbm_fetch mdbm_chain_fetch
581 #define mdbm_delete mdbm_chain_delete
582 #define mdbm_first mdbm_chain_first
583 #define mdbm_next mdbm_chain_next
587 #define MDBM_PG_SZ (4*1024)
589 /*****************************************************************
593 *****************************************************************/
596 ldbm_open( char *name, int rw, int mode, int dbcachesize )
602 "==>(mdbm)ldbm_open(name=%s,rw=%x,mode=%x,cachesize=%d)\n",
603 name ? name : "NULL", rw, mode, dbcachesize );
607 LDBM_LOCK; /* We need locking here, this is the only non-thread
608 * safe function we have.
611 if ( (db = mdbm_open( name, rw, mode, MDBM_PG_SZ )) == NULL ) {
615 fprintf( stdout, "<==(mdbm)ldbm_open(db=NULL)\n" );
623 (void)mdbm_set_chain(db);
629 fprintf( stdout, "<==(mdbm)ldbm_open(db=%p)\n", db );
641 ldbm_close( LDBM ldbm )
644 /* Open and close are not reentrant so we need to use locks here */
648 "==>(mdbm)ldbm_close(db=%p)\n", ldbm );
657 fprintf( stdout, "<==(mdbm)ldbm_close()\n" );
667 ldbm_sync( LDBM ldbm )
670 /* XXX: Not sure if this is re-entrant need to check code, if so
671 * you can leave LOCKS out.
681 #define MAX_MDBM_RETRY 5
684 ldbm_fetch( LDBM ldbm, Datum key )
690 /* This hack is needed because MDBM does not take keys
691 * which begin with NULL when working in the chaining
698 k.key.dsize = key.dsize + 1;
699 k.key.dptr = malloc(k.key.dsize);
701 memcpy( (void *)(k.key.dptr + 1), key.dptr, key.dsize );
711 d = mdbm_fetch( ldbm, k );
715 if ( k.val.dptr != NULL ) {
721 if ( (k.val.dptr = malloc( d.dsize )) != NULL ) {
723 k.val.dsize = d.dsize;
724 d = mdbm_fetch( ldbm, k );
733 }/* if ( d.dsize > 0 ) */
735 } while ((d.dsize > k.val.dsize) && (++retry < MAX_MDBM_RETRY));
751 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
754 Datum int_key; /* Internal key */
758 "==>(mdbm)ldbm_store(db=%p, key(dptr=%p,sz=%d), data(dptr=%p,sz=%d), flags=%x)\n",
759 ldbm, key.dptr, key.dsize, data.dptr, data.dsize, flags );
766 int_key.dsize = key.dsize + 1;
767 int_key.dptr = malloc( int_key.dsize );
768 *(int_key.dptr) = 'l'; /* Must not be NULL !*/
769 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
774 rc = mdbm_store( ldbm, int_key, data, flags );
775 if ( flags & LDBM_SYNC ) {
782 fprintf( stdout, "<==(mdbm)ldbm_store(rc=%d)\n", rc );
797 ldbm_delete( LDBM ldbm, Datum key )
805 int_key.dsize = key.dsize + 1;
806 int_key.dptr = malloc(int_key.dsize);
807 *(int_key.dptr) = 'l';
808 memcpy( (void *)(int_key.dptr + 1), key.dptr, key.dsize );
813 rc = mdbm_delete( ldbm, int_key );
828 ldbm_get_next( LDBM ldbm, kvpair (*fptr)(MDBM *, kvpair) )
834 size_t sz = MDBM_PAGE_SIZE(ldbm);
843 in.key.dsize = sz; /* Assume first key in one pg */
844 in.key.dptr = malloc(sz);
846 in.val.dptr = NULL; /* Don't need data just key */
852 out = fptr( ldbm, in );
854 if (out.key.dsize > 0) {
856 ret.dsize = out.key.dsize - delta;
857 if ((ret.dptr = (char *)malloc(ret.dsize)) == NULL) {
864 memcpy(ret.dptr, (void *)(out.key.dptr + delta),
883 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
886 return ldbm_get_next( ldbm, mdbm_first );
894 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
898 * don't know if this will affect the LDAP server opertaion
899 * but mdbm cannot take and input key.
902 return ldbm_get_next( ldbm, mdbm_next );
907 ldbm_errno( LDBM ldbm )
909 /* XXX: best we can do with current mdbm interface */
917 #elif defined( HAVE_NDBM )
919 /*****************************************************************
921 * if no gdbm or mdbm, fall back to using ndbm, the standard unix thing *
923 *****************************************************************/
927 ldbm_open( char *name, int rw, int mode, int dbcachesize )
932 ldbm = dbm_open( name, rw, mode );
939 ldbm_close( LDBM ldbm )
948 ldbm_sync( LDBM ldbm )
954 ldbm_fetch( LDBM ldbm, Datum key )
959 d = ldbm_datum_dup( ldbm, dbm_fetch( ldbm, key ) );
966 ldbm_store( LDBM ldbm, Datum key, Datum data, int flags )
971 rc = dbm_store( ldbm, key, data, flags );
978 ldbm_delete( LDBM ldbm, Datum key )
983 rc = dbm_delete( ldbm, key );
990 ldbm_firstkey( LDBM ldbm, LDBMCursor **dbcp )
995 d = dbm_firstkey( ldbm );
1002 ldbm_nextkey( LDBM ldbm, Datum key, LDBMCursor *dbcp )
1007 d = dbm_nextkey( ldbm );
1014 ldbm_errno( LDBM ldbm )
1019 err = dbm_error( ldbm );